Please note that this documentation is not final and is subject to change.

A B C E F G H I M N O P R S T U V

A

AbstractNotificationHandler<T> - Class in com.sun.nio.sctp

A skeletal handler that consumes notifications and continues.

AbstractNotificationHandler() - Constructor for class com.sun.nio.sctp.AbstractNotificationHandler

Initializes a new instance of this class.

accept() - Method in class com.sun.nio.sctp.SctpServerChannel

Accepts an association on this channel's socket.

address() - Method in class com.sun.nio.sctp.MessageInfo

Returns the source socket address if the message has been received, otherwise the preferred destination of the message to be sent.

address() - Method in class com.sun.nio.sctp.PeerAddressChangeNotification

Returns the peer address.

address() - Method in class com.sun.nio.sctp.SendFailedNotification

Returns the address.

Association - Class in com.sun.nio.sctp

A class that represents an SCTP association.

Association(int, int, int) - Constructor for class com.sun.nio.sctp.Association

Initializes a new instance of this class.

association() - Method in class com.sun.nio.sctp.AssociationChangeNotification

Returns the association that this notification is applicable to.

association() - Method in class com.sun.nio.sctp.MessageInfo

Returns the association that the message was received on, if the message has been received, otherwise the association that the message is to be sent on.

association() - Method in interface com.sun.nio.sctp.Notification

Returns the association that this notification is applicable to.

association() - Method in class com.sun.nio.sctp.PeerAddressChangeNotification

Returns the association that this notification is applicable to.

association() - Method in class com.sun.nio.sctp.SctpChannel

Returns the association on this channel's socket.

association() - Method in class com.sun.nio.sctp.SendFailedNotification

Returns the association that this notification is applicable to.

association() - Method in class com.sun.nio.sctp.ShutdownNotification

Returns the association that this notification is applicable to.

AssociationChangeNotification - Class in com.sun.nio.sctp

Notification emitted when an association has either opened or closed.

AssociationChangeNotification() - Constructor for class com.sun.nio.sctp.AssociationChangeNotification

Initializes a new instance of this class.

AssociationChangeNotification.AssocChangeEvent - Enum in com.sun.nio.sctp

Defines the type of change event that happened to the association.

associationID() - Method in class com.sun.nio.sctp.Association

Returns the associationID.

associations() - Method in class com.sun.nio.sctp.SctpMultiChannel

Returns the open associations on this channel's socket.

B

bind(SocketAddress) - Method in class com.sun.nio.sctp.SctpChannel

Binds the channel's socket to a local address.

bind(SocketAddress, int) - Method in class com.sun.nio.sctp.SctpMultiChannel

Binds the channel's socket to a local address and configures the socket to listen for connections.

bind(SocketAddress) - Method in class com.sun.nio.sctp.SctpMultiChannel

Binds the channel's socket to a local address and configures the socket to listen for connections.

bind(SocketAddress) - Method in class com.sun.nio.sctp.SctpServerChannel

Binds the channel's socket to a local address and configures the socket to listen for associations.

bind(SocketAddress, int) - Method in class com.sun.nio.sctp.SctpServerChannel

Binds the channel's socket to a local address and configures the socket to listen for associations.

bindAddress(InetAddress) - Method in class com.sun.nio.sctp.SctpChannel

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

bindAddress(InetAddress) - Method in class com.sun.nio.sctp.SctpMultiChannel

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

bindAddress(InetAddress) - Method in class com.sun.nio.sctp.SctpServerChannel

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

branch(Association) - Method in class com.sun.nio.sctp.SctpMultiChannel

Branches off an association.

buffer() - Method in class com.sun.nio.sctp.SendFailedNotification

Returns the data that was to be sent.

bytes() - Method in class com.sun.nio.sctp.MessageInfo

Returns the number of bytes read for the received message.

C

com.sun.nio.sctp - package com.sun.nio.sctp

A Java API for Stream Control Transport Protocol.

complete(boolean) - Method in class com.sun.nio.sctp.MessageInfo

Sets whether or not the message is complete.

connect(SocketAddress) - Method in class com.sun.nio.sctp.SctpChannel

Connects this channel's socket.

connect(SocketAddress, int, int) - Method in class com.sun.nio.sctp.SctpChannel

Connects this channel's socket.

create(int, int) - Static method in class com.sun.nio.sctp.SctpStandardSocketOption.InitMaxStreams

Creates an InitMaxStreams instance.

createOutgoing(SocketAddress, int) - Static method in class com.sun.nio.sctp.MessageInfo

Creates a MessageInfo instance suitable for use when sending a message.

createOutgoing(Association, SocketAddress, int) - Static method in class com.sun.nio.sctp.MessageInfo

Creates a MessageInfo instance suitable for use when sending a message to a given association.

E

equals(Object) - Method in class com.sun.nio.sctp.SctpStandardSocketOption.InitMaxStreams

Returns true if the specified object is another InitMaxStreams instance with the same number of in and out bound streams.

errorCode() - Method in class com.sun.nio.sctp.SendFailedNotification

Returns the error code.

event() - Method in class com.sun.nio.sctp.AssociationChangeNotification

Returns the type of change event.

event() - Method in class com.sun.nio.sctp.PeerAddressChangeNotification

Returns the type of change event.

F

finishConnect() - Method in class com.sun.nio.sctp.SctpChannel

Finishes the process of connecting an SCTP channel.

G

getAllLocalAddresses() - Method in class com.sun.nio.sctp.SctpChannel

Returns all of the socket addresses to which this channel's socket is bound.

getAllLocalAddresses() - Method in class com.sun.nio.sctp.SctpMultiChannel

Returns all of the socket addresses to which this channel's socket is bound.

getAllLocalAddresses() - Method in class com.sun.nio.sctp.SctpServerChannel

Returns all of the socket addresses to which this channel's socket is bound.

getOption(SctpSocketOption<T>) - Method in class com.sun.nio.sctp.SctpChannel

Returns the value of a socket option.

getOption(SctpSocketOption<T>, Association) - Method in class com.sun.nio.sctp.SctpMultiChannel

Returns the value of a socket option.

getOption(SctpSocketOption<T>) - Method in class com.sun.nio.sctp.SctpServerChannel

Returns the value of a socket option.

getRemoteAddresses() - Method in class com.sun.nio.sctp.SctpChannel

Returns all of the remote addresses to which this channel's socket is connected.

getRemoteAddresses(Association) - Method in class com.sun.nio.sctp.SctpMultiChannel

Returns all of the remote addresses to which the given association on this channel's socket is connected.

H

handleNotification(Notification, T) - Method in class com.sun.nio.sctp.AbstractNotificationHandler

Invoked when an implementation specific notification is received from the SCTP stack.

handleNotification(AssociationChangeNotification, T) - Method in class com.sun.nio.sctp.AbstractNotificationHandler

Invoked when an AssociationChangeNotification is received from the SCTP stack.

handleNotification(PeerAddressChangeNotification, T) - Method in class com.sun.nio.sctp.AbstractNotificationHandler

Invoked when an PeerAddressChangeNotification is received from the SCTP stack.

handleNotification(SendFailedNotification, T) - Method in class com.sun.nio.sctp.AbstractNotificationHandler

Invoked when an SendFailedNotification is received from the SCTP stack.

handleNotification(ShutdownNotification, T) - Method in class com.sun.nio.sctp.AbstractNotificationHandler

Invoked when an ShutdownNotification is received from the SCTP stack.

handleNotification(Notification, T) - Method in interface com.sun.nio.sctp.NotificationHandler

Invoked when a notification is received from the SCTP stack.

HandlerResult - Enum in com.sun.nio.sctp

Defines notification handler results.

hashCode() - Method in class com.sun.nio.sctp.SctpStandardSocketOption.InitMaxStreams

Returns a hash code value for this init max streams.

I

IllegalReceiveException - Exception in com.sun.nio.sctp

Unchecked exception thrown when an attempt is made to invoke the receive method of SctpChannel or SctpMultiChannel from a notification handler.

IllegalReceiveException() - Constructor for exception com.sun.nio.sctp.IllegalReceiveException

Constructs an instance of this class.

IllegalReceiveException(String) - Constructor for exception com.sun.nio.sctp.IllegalReceiveException

Constructs an instance of this class with the specified message.

IllegalUnbindException - Exception in com.sun.nio.sctp

Unchecked exception thrown when an attempt is made to remove an address that is not bound to the channel, or remove an address from a channel that has only one address bound to it.

IllegalUnbindException() - Constructor for exception com.sun.nio.sctp.IllegalUnbindException

Constructs an instance of this class.

IllegalUnbindException(String) - Constructor for exception com.sun.nio.sctp.IllegalUnbindException

Constructs an instance of this class with the specified detailed message.

InvalidStreamException - Exception in com.sun.nio.sctp

Unchecked exception thrown when an attempt is made to send a message to an invalid stream.

InvalidStreamException() - Constructor for exception com.sun.nio.sctp.InvalidStreamException

Constructs an instance of this class.

InvalidStreamException(String) - Constructor for exception com.sun.nio.sctp.InvalidStreamException

Constructs an instance of this class with the specified detailed message.

isComplete() - Method in class com.sun.nio.sctp.MessageInfo

Tells whether or not the message is complete.

isConnectionPending() - Method in class com.sun.nio.sctp.SctpChannel

Tells whether or not a connection operation is in progress on this channel.

isUnordered() - Method in class com.sun.nio.sctp.MessageInfo

Tells whether or not the message is unordered.

M

maxInboundStreams() - Method in class com.sun.nio.sctp.Association

Returns the maximum number of inbound streams that this association supports.

maxInStreams() - Method in class com.sun.nio.sctp.SctpStandardSocketOption.InitMaxStreams

Returns the maximum number of inbound streams.

maxOutboundStreams() - Method in class com.sun.nio.sctp.Association

Returns the maximum number of outbound streams that this association supports.

maxOutStreams() - Method in class com.sun.nio.sctp.SctpStandardSocketOption.InitMaxStreams

Returns the maximum number of outbound streams.

MessageInfo - Class in com.sun.nio.sctp

The MessageInfo class provides additional ancillary information about messages.

MessageInfo() - Constructor for class com.sun.nio.sctp.MessageInfo

Initializes a new instance of this class.

N

Notification - Interface in com.sun.nio.sctp

A notification from the SCTP stack.

NotificationHandler<T> - Interface in com.sun.nio.sctp

A handler for consuming notifications from the SCTP stack.

O

open() - Static method in class com.sun.nio.sctp.SctpChannel

Opens an SCTP channel.

open(SocketAddress, int, int) - Static method in class com.sun.nio.sctp.SctpChannel

Opens an SCTP channel and connects it to a remote address.

open() - Static method in class com.sun.nio.sctp.SctpMultiChannel

Opens an SCTP multi channel.

open() - Static method in class com.sun.nio.sctp.SctpServerChannel

Opens an SCTP server channel.

P

payloadProtocolID() - Method in class com.sun.nio.sctp.MessageInfo

Returns the payload protocol Identifier.

payloadProtocolID(int) - Method in class com.sun.nio.sctp.MessageInfo

Sets the payload protocol Identifier.

PeerAddressChangeNotification - Class in com.sun.nio.sctp

Notification emitted when a destination address on a multi-homed peer encounters a change.

PeerAddressChangeNotification() - Constructor for class com.sun.nio.sctp.PeerAddressChangeNotification

Initializes a new instance of this class.

PeerAddressChangeNotification.AddressChangeEvent - Enum in com.sun.nio.sctp

Defines the type of address change event that occurred to the destination address on a multi-homed peer when it encounters a change of interface details.

R

receive(ByteBuffer, T, NotificationHandler<T>) - Method in class com.sun.nio.sctp.SctpChannel

Receives a message into the given buffer and/or handles a notification.

receive(ByteBuffer, T, NotificationHandler<T>) - Method in class com.sun.nio.sctp.SctpMultiChannel

Receives a message and/or handles a notification via this channel.

S

SCTP_DISABLE_FRAGMENTS - Static variable in class com.sun.nio.sctp.SctpStandardSocketOption

Enables or disables message fragmentation.

SCTP_EXPLICIT_COMPLETE - Static variable in class com.sun.nio.sctp.SctpStandardSocketOption

Enables or disables explicit message completion.

SCTP_FRAGMENT_INTERLEAVE - Static variable in class com.sun.nio.sctp.SctpStandardSocketOption

Fragmented interleave controls how the presentation of messages occur for the message receiver.

SCTP_INIT_MAXSTREAMS - Static variable in class com.sun.nio.sctp.SctpStandardSocketOption

The maximum number of streams requested by the local endpoint during association initialization.

SCTP_NODELAY - Static variable in class com.sun.nio.sctp.SctpStandardSocketOption

Enables or disables a Nagle-like algorithm.

SCTP_PRIMARY_ADDR - Static variable in class com.sun.nio.sctp.SctpStandardSocketOption

Requests that the local SCTP stack use the given peer address as the association primary.

SCTP_SET_PEER_PRIMARY_ADDR - Static variable in class com.sun.nio.sctp.SctpStandardSocketOption

Requests that the peer mark the enclosed address as the association primary.

SctpChannel - Class in com.sun.nio.sctp

A selectable channel for message-oriented connected SCTP sockets.

SctpChannel(SelectorProvider) - Constructor for class com.sun.nio.sctp.SctpChannel

Initializes a new instance of this class.

SctpMultiChannel - Class in com.sun.nio.sctp

A selectable channel for message-oriented SCTP sockets.

SctpMultiChannel(SelectorProvider) - Constructor for class com.sun.nio.sctp.SctpMultiChannel

Initializes a new instance of this class.

SctpServerChannel - Class in com.sun.nio.sctp

A selectable channel for message-oriented listening SCTP sockets.

SctpServerChannel(SelectorProvider) - Constructor for class com.sun.nio.sctp.SctpServerChannel

Initializes a new instance of this class.

SctpSocketOption<T> - Interface in com.sun.nio.sctp

A socket option associated with an SCTP channel.

SctpStandardSocketOption - Class in com.sun.nio.sctp

SCTP channels supports the socket options defined by this class (as well as those listed in the particular channel class) and may support additional Implementation specific socket options.

SctpStandardSocketOption.InitMaxStreams - Class in com.sun.nio.sctp

This class is used to set the maximum number of inbound/outbound streams used by the local endpoint during association initialization.

send(ByteBuffer, MessageInfo) - Method in class com.sun.nio.sctp.SctpChannel

Sends a message via this channel.

send(ByteBuffer, MessageInfo) - Method in class com.sun.nio.sctp.SctpMultiChannel

Sends a message via this channel.

SendFailedNotification - Class in com.sun.nio.sctp

Notification emitted when a send failed notification has been received.

SendFailedNotification() - Constructor for class com.sun.nio.sctp.SendFailedNotification

Initializes a new instance of this class.

setOption(SctpSocketOption<T>, T) - Method in class com.sun.nio.sctp.SctpChannel

Sets the value of a socket option.

setOption(SctpSocketOption<T>, T, Association) - Method in class com.sun.nio.sctp.SctpMultiChannel

Sets the value of a socket option.

setOption(SctpSocketOption<T>, T) - Method in class com.sun.nio.sctp.SctpServerChannel

Sets the value of a socket option.

shutdown() - Method in class com.sun.nio.sctp.SctpChannel

Shutdown a connection without closing the channel.

shutdown(Association) - Method in class com.sun.nio.sctp.SctpMultiChannel

Shutdown an association without closing the channel.

ShutdownNotification - Class in com.sun.nio.sctp

Notification emitted when a peers shutdowns an the association.

ShutdownNotification() - Constructor for class com.sun.nio.sctp.ShutdownNotification

Initializes a new instance of this class.

SO_LINGER - Static variable in class com.sun.nio.sctp.SctpStandardSocketOption

Linger on close if data is present.

SO_RCVBUF - Static variable in class com.sun.nio.sctp.SctpStandardSocketOption

The size of the socket receive buffer.

SO_SNDBUF - Static variable in class com.sun.nio.sctp.SctpStandardSocketOption

The size of the socket send buffer.

streamNumber() - Method in class com.sun.nio.sctp.MessageInfo

Returns the stream number that the message was received on, if the message has been received, otherwise the stream number that the message is to be sent on.

streamNumber(int) - Method in class com.sun.nio.sctp.MessageInfo

Sets the stream number that the message is to be sent on.

streamNumber() - Method in class com.sun.nio.sctp.SendFailedNotification

Returns the stream number that the messge was to be sent on.

supportedOptions() - Method in class com.sun.nio.sctp.SctpChannel

Returns a set of the socket options supported by this channel.

supportedOptions() - Method in class com.sun.nio.sctp.SctpMultiChannel

Returns a set of the socket options supported by this channel.

supportedOptions() - Method in class com.sun.nio.sctp.SctpServerChannel

Returns a set of the socket options supported by this channel.

T

timeToLive() - Method in class com.sun.nio.sctp.MessageInfo

The time period that the sending side may expire the message if it has not been sent, or 0 to indicate that no timeout should occur.

timeToLive(long) - Method in class com.sun.nio.sctp.MessageInfo

Sets the time period that the sending side may expire the message if it has not been sent.

toString() - Method in class com.sun.nio.sctp.SctpStandardSocketOption.InitMaxStreams

Returns a string representation of this init max streams, including the maximum in and out bound streams.

U

unbindAddress(InetAddress) - Method in class com.sun.nio.sctp.SctpChannel

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

unbindAddress(InetAddress) - Method in class com.sun.nio.sctp.SctpMultiChannel

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

unbindAddress(InetAddress) - Method in class com.sun.nio.sctp.SctpServerChannel

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

unordered(boolean) - Method in class com.sun.nio.sctp.MessageInfo

Sets whether or not the message is unordered.

V

validOps() - Method in class com.sun.nio.sctp.SctpChannel

Returns an operation set identifying this channel's supported operations.

validOps() - Method in class com.sun.nio.sctp.SctpMultiChannel

Returns an operation set identifying this channel's supported operations.

validOps() - Method in class com.sun.nio.sctp.SctpServerChannel

Returns an operation set identifying this channel's supported operations.

valueOf(String) - Static method in enum com.sun.nio.sctp.AssociationChangeNotification.AssocChangeEvent

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.sun.nio.sctp.HandlerResult

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.sun.nio.sctp.PeerAddressChangeNotification.AddressChangeEvent

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.sun.nio.sctp.AssociationChangeNotification.AssocChangeEvent

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.sun.nio.sctp.HandlerResult

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.sun.nio.sctp.PeerAddressChangeNotification.AddressChangeEvent

Returns an array containing the constants of this enum type, in the order they are declared.

A B C E F G H I M N O P R S T U V