Sctp

Type Members

1. sealed trait AssociationNotification extends Notification

   

2. final case class Bind(handler: ActorRef, localAddress: InetSocketAddress, maxInboundStreams: Int = 0, maxOutboundStreams: Int = 0, additionalAddresses: Set[InetAddress] = Set.empty, backlog: Int = 100, options: Traversable[SctpSocketOption] = Nil) extends Command with Product with Serializable

   

   The Bind message is send to the SCTP manager actor, which is obtained via StcpExt#manager in order to bind to a listening socket.

   The Bind message is send to the SCTP manager actor, which is obtained via StcpExt#manager in order to bind to a listening socket. The manager replies either with a CommandFailed or the actor handling the listen socket replies with a Bound message. If the local port is set to 0 in the Bind message, then the Bound message should be inspected to find the actual port which was bound to.

   handler

   The actor which will receive all incoming connection requests in the form of Connected messages.

   localAddress

   The socket address to bind to; use port zero for automatic assignment (i.e. an ephemeral port, see Bound)

   backlog

   This specifies the number of unaccepted connections the O/S kernel will hold for this port before refusing connections.

   options

   Please refer to the SO object for a list of all supported options.

3. final case class BindAddress(address: InetAddress) extends Command with Product with Serializable

   

   Adds the given address to the bound addresses for the channel's socket.

   Adds the given address to the bound addresses for the channel's socket. The given address must not be the wildcard address. The channel must be first bound using bind before invoking this method, otherwise NotYetBoundException is thrown. Addresses subquently bound using this method are simply addresses as the SCTP port number remains the same for the lifetime of the channel. Adding addresses to a connected association is optional functionality. If the endpoint supports dynamic address reconfiguration then it may send the appropriate message to the peer to change the peers address lists.

4. final case class Bound(localAddresses: Set[InetSocketAddress], port: Int) extends Event with Product with Serializable

   

   The sender of a Bind command will—in case of success—receive confirmation in this form.

   The sender of a Bind command will—in case of success—receive confirmation in this form. If the bind address indicated a 0 port number, then the contained localAddress can be used to find out which port was automatically assigned.

5. sealed trait CloseCommand extends Command

   

   Common interface for all commands which aim to close down an open connection.

6. trait Command extends Message with HasFailureMessage

   

   This is the common trait for all commands understood by SCTP actors.

7. final case class CommandFailed(cmd: Command) extends Event with Product with Serializable

   

   Whenever a command cannot be completed, the queried actor will reply with this message, wrapping the original command which failed.

8. final case class Connect(remoteAddress: InetSocketAddress, maxOutboundStreams: Int = 0, maxInboundStreams: Int = 0, localAddress: Option[InetSocketAddress] = None, additionalAddresses: Set[InetAddress] = Set.empty, options: Traversable[SctpSocketOption] = Nil, timeout: Option[FiniteDuration] = None) extends Command with Product with Serializable

   

   The Connect message is sent to the SCTP manager actor, which is obtained via StcpExt#manager.

   The Connect message is sent to the SCTP manager actor, which is obtained via StcpExt#manager. Either the manager replies with a CommandFailed or the actor handling the new connection replies with a Connected message.

   remoteAddress

   is the address to connect to

   localAddress

   optionally specifies a specific address to bind to

   options

   Please refer to the SO object for a list of all supported options.

9. final case class Connected(remoteAddresses: Set[InetSocketAddress], localAddresses: Set[InetSocketAddress], association: SctpAssociation) extends Event with Product with Serializable

   

   The connection actor sends this message either to the sender of a Connect command (for outbound) or to the handler for incoming connections designated in the Bind message.

   The connection actor sends this message either to the sender of a Connect command (for outbound) or to the handler for incoming connections designated in the Bind message. The connection is characterized by the remoteAddresses and localAddresses SCTP endpoints, and association.

10. sealed trait ConnectionClosed extends Event with DeadLetterSuppression

    

    This is the common interface for all events which indicate that a connection has been closed or half-closed.

11. final case class ErrorClosed(cause: String) extends ConnectionClosed with Product with Serializable

    

    The connection has been closed due to an IO error.

12. trait Event extends Message

    

    Common interface for all events generated by the SCTP layer actors.

13. sealed trait Message extends NoSerializationVerificationNeeded

    

    The common interface for Command and Event.

14. case class NoAck(token: Any) extends Event with Product with Serializable

    

    Each Send can optionally request a positive acknowledgment to be sent to the commanding actor.

    Each Send can optionally request a positive acknowledgment to be sent to the commanding actor. If such notification is not desired the Send#ack must be set to an instance of this class. The token contained within can be used to recognize which write failed when receiving a CommandFailed message.

15. sealed trait Notification extends Message

    

16. sealed trait PeerAddressNotification extends Notification

    

17. final case class Received(message: SctpMessage) extends Event with Product with Serializable

    

    Whenever sctp message is read from a socket it will be transferred within this class to the handler actor which was designated in the Register message.

18. final case class Register(handler: ActorRef, notificationHandlerOpt: Option[ActorRef] = None) extends Command with Product with Serializable

    

    This message must be sent to a SCTP connection actor after receiving the Connected message.

    This message must be sent to a SCTP connection actor after receiving the Connected message. The connection will not read any data from the socket until this message is received, because this message defines the actor which will receive all inbound data.

    handler

    The actor which will receive all incoming data and which will be informed when the connection is closed.

19. final case class SctpAssociation(id: Int, maxInboundStreams: Int, maxOutboundStreams: Int) extends Product with Serializable

    

20. final case class SctpMessage(info: SctpMessageInfo, payload: Bytes) extends Product with Serializable

    

21. final case class SctpMessageInfo(streamNumber: Int, payloadProtocolID: Int, timeToLive: Long, unordered: Boolean, bytes: Int, association: SctpAssociation, address: InetSocketAddress) extends Product with Serializable

    

22. final case class Send(message: SctpMessage, ack: Event = NoAck) extends Command with Product with Serializable

    

    Send data to the SCTP connection.

    Send data to the SCTP connection. If no ack is needed use the special NoAck object. The connection actor will reply with a CommandFailed message if the write could not be enqueued. If Send#wantsAck returns true, the connection actor will reply with the supplied Send#ack token once the write has been successfully enqueued to the O/S kernel. Note that this does not in any way guarantee that the data will be or have been sent! Unfortunately there is no way to determine whether a particular write has been sent by the O/S.

23. case class SendFailedNotification(payload: Bytes, streamNumber: Int, errorCode: Int, address: InetSocketAddress) extends Notification with Product with Serializable

    

24. final case class UnbindAddress(address: InetAddress) extends Command with Product with Serializable

    

    Removes the given address from the bound addresses for the channel's socket.

    Removes the given address from the bound addresses for the channel's socket. The given address must not be the wildcard address. The channel must be first bound using bind before invoking this method, otherwise NotYetBoundException is thrown. If this method is invoked on a channel that does not have address as one of its bound addresses or that has only one local address bound to it, then this method throws IllegalUnbindException. The initial address that the channel's socket is bound to using bind may be removed from the bound addresses for the channel's socket. Removing addresses from a connected association is optional functionality. If the endpoint supports dynamic address reconfiguration then it may send the appropriate message to the peer to change the peers address lists.

25. sealed trait Unbound extends Event

    

    The sender of an Unbind command will receive confirmation through this message once the listening socket has been closed.