ResumptionSupportingConnectionStore (Scandium (Sc) Core 2.8.0 API)

All Known Implementing Classes:

InMemoryConnectionStore
```
public interface ResumptionSupportingConnectionStore
```
A connection store which adds support of connection resumption.

Since:

1.1

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`attach(ConnectionIdGenerator connectionIdGenerator)` Attach connection id generator.
`void`	`clear()` Removes all connections from the store.
`Connection`	`find(SessionId id)` Finds a connection by its session ID.
`Connection`	`get(ConnectionId cid)` Gets a connection by its connection id.
`Connection`	`get(InetSocketAddress peerAddress)` Gets a connection by its peer address.
`Iterator<Connection>`	`iterator()` Get "weakly consistent" iterator over all connections.
`void`	`markAllAsResumptionRequired()` Mark all connections as resumption required.
`boolean`	`put(Connection connection)` Puts a connection into the store.
`void`	`putEstablishedSession(DTLSSession session, Connection connection)` Associates the connection with the session id.
`int`	`remainingCapacity()` Gets the number of additional connection this store can manage.
`boolean`	`remove(Connection connection)` Removes a connection from the store and session cache.
`boolean`	`remove(Connection connection, boolean removeFromSessionCache)` Removes a connection from the store and optional from the session cache.
`void`	`removeFromEstablishedSessions(DTLSSession session, Connection connection)` Remove the association of the connection with the session id.
`void`	`setConnectionListener(ConnectionListener listener)`
`void`	`stop(List<Runnable> pending)` Stop all serial executors of connections from the store.
`boolean`	`update(Connection connection, InetSocketAddress newPeerAddress)` Update a connection in the store.

- Method Detail
  - setConnectionListener
```
void setConnectionListener(ConnectionListener listener)
```
  - attach
```
void attach(ConnectionIdGenerator connectionIdGenerator)
```
    Attach connection id generator. Must be called before put(Connection).
    
    Parameters:
    connectionIdGenerator - connection id generator. If null a default connection id generator is created.
    
    Throws:
    
    IllegalStateException - if attach(ConnectionIdGenerator) was already called before.
  - put
```
boolean put(Connection connection)
```
    Puts a connection into the store. The connection is primary associated with its connection id Connection.getConnectionId(). If the connection doesn't have a connection id, a unique connection id created with the attach(ConnectionIdGenerator) is assigned. If the connection has also a peer address and/or a established session, it get's associated with that as well. It removes also an other connection from these associations. Note: attach(ConnectionIdGenerator) must be called before!
    
    Parameters:
    connection - the connection to store
    
    Returns:
    true if the connection could be stored, false, otherwise (e.g. because the store's capacity is exhausted)
    
    Throws:
    
    IllegalStateException - if the connection is not executing, the connection ids are exhausted, or the connection id is empty or in use, or the connection id generator is not attach(ConnectionIdGenerator) before!
    See Also:
    get(ConnectionId), get(InetSocketAddress), find(SessionId)
  - update
```
boolean update(Connection connection,
             InetSocketAddress newPeerAddress)
```
    Update a connection in the store. Update the last-access time to prevent connection from being evicted. Associate a new peer address with this connection, and removes other connections from that association.
    
    Parameters:
    connection - the connection to update.
    newPeerAddress - the (new) peer address. If null, don't update the connection's address.
    
    Returns:
    true, if updated, false, otherwise.
  - putEstablishedSession
```
void putEstablishedSession(DTLSSession session,
                         Connection connection)
```
    Associates the connection with the session id. Removes previous associated connection from store.
    
    Parameters:
    session - established session.
    connection - connection of established session
  - removeFromEstablishedSessions
```
void removeFromEstablishedSessions(DTLSSession session,
                                 Connection connection)
```
    Remove the association of the connection with the session id.
    
    Parameters:
    session - established session.
    connection - connection of established session
  - remainingCapacity
```
int remainingCapacity()
```
    Gets the number of additional connection this store can manage.
    
    Returns:
    the remaining capacity
  - get
```
Connection get(InetSocketAddress peerAddress)
```
    Gets a connection by its peer address.
    
    Parameters:
    peerAddress - the peer address
    
    Returns:
    the matching connection or null if no connection exists for the given address
  - get
```
Connection get(ConnectionId cid)
```
    Gets a connection by its connection id.
    
    Parameters:
    cid - connection id
    
    Returns:
    the matching connection or null if no connection exists for the given connection id
  - find
```
Connection find(SessionId id)
```
    Finds a connection by its session ID.
    
    Parameters:
    id - the session ID
    
    Returns:
    the matching connection or null if no connection with an established session with the given ID exists
  - remove
```
boolean remove(Connection connection)
```
    Removes a connection from the store and session cache.
    
    Parameters:
    connection - the connection to remove
    
    Returns:
    true if the connection was removed, false, otherwise
  - remove
```
boolean remove(Connection connection,
             boolean removeFromSessionCache)
```
    Removes a connection from the store and optional from the session cache.
    
    Parameters:
    connection - the connection to remove
    removeFromSessionCache - true if the session of the connection should be removed from the session cache, false, otherwise
    
    Returns:
    true if the connection was removed, false, otherwise
  - clear
```
void clear()
```
    Removes all connections from the store.
  - stop
```
void stop(List<Runnable> pending)
```
    Stop all serial executors of connections from the store. Add pending jobs to provided list.
    
    Parameters:
    pending - list to add pending jobs
  - markAllAsResumptionRequired
```
void markAllAsResumptionRequired()
```
    Mark all connections as resumption required.
  - iterator
```
Iterator<Connection> iterator()
```
    Get "weakly consistent" iterator over all connections. The iterator is a "weakly consistent" iterator that will never throw ConcurrentModificationException, and guarantees to traverse elements as they existed upon construction of the iterator, and may (but is not guaranteed to) reflect any modifications subsequent to construction.
    
    Returns:
    "weakly consistent" iterator

Interface ResumptionSupportingConnectionStore

Method Summary

Method Detail

setConnectionListener

attach

put

update

putEstablishedSession

removeFromEstablishedSessions

remainingCapacity

get

get

find

remove

remove

clear

stop

markAllAsResumptionRequired

iterator