Index (Restcomm :: SCTP :: API :: sctp-api 2.0.18 API)

A C G I M O P R S T V

A

acceptAnonymousAssociation(AssociationListener) - Method in interface org.mobicents.protocols.api.Association: Use this method only for accepting anonymous connections from the ServerListener.onNewRemoteConnection() invoking
addAssociation(String, int, String, int, String) - Method in interface org.mobicents.protocols.api.Management: Add Association.
addAssociation(String, int, String, int, String, IpChannelType, String[]) - Method in interface org.mobicents.protocols.api.Management: Add Association
addCongestionListener(CongestionListener) - Method in interface org.mobicents.protocols.api.Management: Adding CongestionListener.
addManagementEventListener(ManagementEventListener) - Method in interface org.mobicents.protocols.api.Management: Adding ManagementEventListener.
addServer(String, String, int, IpChannelType, boolean, int, String[]) - Method in interface org.mobicents.protocols.api.Management: Add new Server.
addServer(String, String, int, IpChannelType, String[]) - Method in interface org.mobicents.protocols.api.Management: Add new Server.
addServer(String, String, int) - Method in interface org.mobicents.protocols.api.Management: Add new Server.
addServerAssociation(String, int, String, String) - Method in interface org.mobicents.protocols.api.Management: Add server Association.
addServerAssociation(String, int, String, String, IpChannelType) - Method in interface org.mobicents.protocols.api.Management: Add server Association.
Association - Interface in org.mobicents.protocols.api: A protocol relationship between endpoints
AssociationListener - Interface in org.mobicents.protocols.api: The listener interface for receiving the underlying socket status and received payload from peer.
AssociationType - Enum in org.mobicents.protocols.api

C

CongestionListener - Interface in org.mobicents.protocols.api

G

getAnonymAssociations() - Method in interface org.mobicents.protocols.api.Server: Returns an unmodifiable list of anonymous associations that are connected at the moment
getAssociation(String) - Method in interface org.mobicents.protocols.api.Management: Get existing Association for passed name
getAssociationListener() - Method in interface org.mobicents.protocols.api.Association: The AssociationListener set for this Association
getAssociations() - Method in interface org.mobicents.protocols.api.Management: Get configured Association map with name as key and Association instance as value
getAssociations() - Method in interface org.mobicents.protocols.api.Server: Association configured for this Server Anonymous associations are not present in this list
getAssociationType() - Method in interface org.mobicents.protocols.api.Association: Return the type of Association CLIENT or SERVER
getAssociationType(String) - Static method in enum org.mobicents.protocols.api.AssociationType
getBufferSize() - Method in interface org.mobicents.protocols.api.Management: Get a sending / receiving buffer size per an association (in bytes).
getByteBuf() - Method in class org.mobicents.protocols.api.PayloadData
getByteBufAllocator() - Method in interface org.mobicents.protocols.api.Association: Return ByteBufAllocator if the underlying Channel is netty or null if not
getCode() - Method in enum org.mobicents.protocols.api.IpChannelType
getCongControl_BackToNormalDelayThreshold_1() - Method in interface org.mobicents.protocols.api.Management: For outgoing messages congestion control we need to have 3 thresholds - delays of outgoing messages before it will be sent to IP channel (3 levels - 1, 2, 3).
getCongControl_BackToNormalDelayThreshold_2() - Method in interface org.mobicents.protocols.api.Management: For outgoing messages congestion control we need to have 3 thresholds - delays of outgoing messages before it will be sent to IP channel (3 levels - 1, 2, 3).
getCongControl_BackToNormalDelayThreshold_3() - Method in interface org.mobicents.protocols.api.Management: For outgoing messages congestion control we need to have 3 thresholds - delays of outgoing messages before it will be sent to IP channel (3 levels - 1, 2, 3).
getCongControl_DelayThreshold_1() - Method in interface org.mobicents.protocols.api.Management: For outgoing messages congestion control we need to have 3 thresholds - delays of outgoing messages before it will be sent to IP channel (3 levels - 1, 2, 3).
getCongControl_DelayThreshold_2() - Method in interface org.mobicents.protocols.api.Management: For outgoing messages congestion control we need to have 3 thresholds - delays of outgoing messages before it will be sent to IP channel (3 levels - 1, 2, 3).
getCongControl_DelayThreshold_3() - Method in interface org.mobicents.protocols.api.Management: For outgoing messages congestion control we need to have 3 thresholds - delays of outgoing messages before it will be sent to IP channel (3 levels - 1, 2, 3).
getCongestionLevel() - Method in interface org.mobicents.protocols.api.Association: Return the last measured Congestion Level at the sending direction
getConnectDelay() - Method in interface org.mobicents.protocols.api.Management: Get connection delay.
getData() - Method in class org.mobicents.protocols.api.PayloadData
getDataLength() - Method in class org.mobicents.protocols.api.PayloadData
getExtraHostAddresses() - Method in interface org.mobicents.protocols.api.Association: When SCTP multi-homing configuration extra IP addresses are here
getExtraHostAddresses() - Method in interface org.mobicents.protocols.api.Server: When SCTP multi-homing configuration extra IP addresses are here
getHostAddress() - Method in interface org.mobicents.protocols.api.Association: The host address that underlying socket is bound to
getHostAddress() - Method in interface org.mobicents.protocols.api.Server: The host address that this server socket is bound to
getHostPort() - Method in interface org.mobicents.protocols.api.Association: The host port that underlying socket is bound to
getHostport() - Method in interface org.mobicents.protocols.api.Server: The host port that this server socket is bound to
getInstance(int) - Static method in enum org.mobicents.protocols.api.IpChannelType
getInstance(String) - Static method in enum org.mobicents.protocols.api.IpChannelType
getIpChannelType() - Method in interface org.mobicents.protocols.api.Association: Return the Association channel type TCP or SCTP
getIpChannelType() - Method in interface org.mobicents.protocols.api.Server: Get the Server channel type - TCP or SCTP
getMaxConcurrentConnectionsCount() - Method in interface org.mobicents.protocols.api.Server: Return the count of concurrent connections that can accept a Server.
getName() - Method in interface org.mobicents.protocols.api.Association: Each association has unique name
getName() - Method in interface org.mobicents.protocols.api.Management: Returns the name of this Management instance
getName() - Method in interface org.mobicents.protocols.api.Server: Get name of this Server.
getOptionSctpDisableFragments() - Method in interface org.mobicents.protocols.api.Management: SCTP option: Enables or disables message fragmentation.
getOptionSctpFragmentInterleave() - Method in interface org.mobicents.protocols.api.Management: SCTP option: Fragmented interleave controls how the presentation of messages occur for the message receiver.
getOptionSctpInitMaxstreams_MaxInStreams() - Method in interface org.mobicents.protocols.api.Management: SCTP option: The maximum number of streams requested by the local endpoint during association initialization For an SctpServerChannel this option determines the maximum number of inbound streams accepted sockets will negotiate with their connecting peer.
getOptionSctpInitMaxstreams_MaxOutStreams() - Method in interface org.mobicents.protocols.api.Management: SCTP option: The maximum number of streams requested by the local endpoint during association initialization For an SctpServerChannel this option determines the maximum number of outbound streams accepted sockets will negotiate with their connecting peer.
getOptionSctpNodelay() - Method in interface org.mobicents.protocols.api.Management: SCTP option: Enables or disables a Nagle-like algorithm.
getOptionSoLinger() - Method in interface org.mobicents.protocols.api.Management: SCTP option: Linger on close if data is present.
getOptionSoRcvbuf() - Method in interface org.mobicents.protocols.api.Management: SCTP option: The size of the socket receive buffer.
getOptionSoSndbuf() - Method in interface org.mobicents.protocols.api.Management: SCTP option: The size of the socket send buffer.
getPayloadProtocolId() - Method in class org.mobicents.protocols.api.PayloadData
getPeerAddress() - Method in interface org.mobicents.protocols.api.Association: The peer address that the underlying socket connects to
getPeerPort() - Method in interface org.mobicents.protocols.api.Association: The peer port that the underlying socket is connected to
getPersistDir() - Method in interface org.mobicents.protocols.api.Management: Get persist dir
getServerListener() - Method in interface org.mobicents.protocols.api.Management: The AssociationListener set for this Association
getServerName() - Method in interface org.mobicents.protocols.api.Association: Server name if the association is for Server
getServers() - Method in interface org.mobicents.protocols.api.Management: Get the list of Servers configured
getStreamNumber() - Method in class org.mobicents.protocols.api.PayloadData: This is SCTP Stream sequence identifier.
getType() - Method in enum org.mobicents.protocols.api.AssociationType
getType() - Method in enum org.mobicents.protocols.api.IpChannelType
getWorkerThreads() - Method in interface org.mobicents.protocols.api.Management: This method is not used more.

I

inValidStreamId(PayloadData) - Method in interface org.mobicents.protocols.api.AssociationListener: The stream id set in outgoing PayloadData is invalid.
IpChannelType - Enum in org.mobicents.protocols.api
isAcceptAnonymousConnections() - Method in interface org.mobicents.protocols.api.Server: Return if this Server accepts Anonymous connections
isComplete() - Method in class org.mobicents.protocols.api.PayloadData
isConnected() - Method in interface org.mobicents.protocols.api.Association: If this association up (connection is started and established)
isSingleThread() - Method in interface org.mobicents.protocols.api.Management: This method is not used more.
isStarted() - Method in interface org.mobicents.protocols.api.Association: If this association is started by management
isStarted() - Method in interface org.mobicents.protocols.api.Management: returns true if Management is started
isStarted() - Method in interface org.mobicents.protocols.api.Server: If the server is started
isUnordered() - Method in class org.mobicents.protocols.api.PayloadData
isUp() - Method in interface org.mobicents.protocols.api.Association: If this association up (connection is established)

M

Management - Interface in org.mobicents.protocols.api: Management class manages the underlying Association and Server.
ManagementEventListener - Interface in org.mobicents.protocols.api

O

onAssociationAdded(Association) - Method in interface org.mobicents.protocols.api.ManagementEventListener
onAssociationDown(Association) - Method in interface org.mobicents.protocols.api.ManagementEventListener
onAssociationRemoved(Association) - Method in interface org.mobicents.protocols.api.ManagementEventListener
onAssociationStarted(Association) - Method in interface org.mobicents.protocols.api.ManagementEventListener
onAssociationStopped(Association) - Method in interface org.mobicents.protocols.api.ManagementEventListener
onAssociationUp(Association) - Method in interface org.mobicents.protocols.api.ManagementEventListener
onCommunicationLost(Association) - Method in interface org.mobicents.protocols.api.AssociationListener: Invoked when underlying socket lost the connection with peer due to any reason like network between peer's died etc.
onCommunicationRestart(Association) - Method in interface org.mobicents.protocols.api.AssociationListener: Invoked when the connection with the peer re-started.
onCommunicationShutdown(Association) - Method in interface org.mobicents.protocols.api.AssociationListener: Invoked when underlying socket is shutdown and connection is ended with peer.
onCommunicationUp(Association, int, int) - Method in interface org.mobicents.protocols.api.AssociationListener: Invoked when underlying socket is open and connection is established with peer.
onCongLevelChanged(Association, int, int) - Method in interface org.mobicents.protocols.api.CongestionListener
onNewRemoteConnection(Server, Association) - Method in interface org.mobicents.protocols.api.ServerListener
onPayload(Association, PayloadData) - Method in interface org.mobicents.protocols.api.AssociationListener: Invoked when the PayloadData is received from peer
onRemoveAllResources() - Method in interface org.mobicents.protocols.api.ManagementEventListener
onServerAdded(Server) - Method in interface org.mobicents.protocols.api.ManagementEventListener
onServerRemoved(Server) - Method in interface org.mobicents.protocols.api.ManagementEventListener
onServiceStarted() - Method in interface org.mobicents.protocols.api.ManagementEventListener
onServiceStopped() - Method in interface org.mobicents.protocols.api.ManagementEventListener
org.mobicents.protocols.api - package org.mobicents.protocols.api

P

PayloadData - Class in org.mobicents.protocols.api: The actual pay load data received or to be sent from/to underlying socket
PayloadData(int, ByteBuf, boolean, boolean, int, int) - Constructor for class org.mobicents.protocols.api.PayloadData
PayloadData(int, byte[], boolean, boolean, int, int) - Constructor for class org.mobicents.protocols.api.PayloadData

R

rejectAnonymousAssociation() - Method in interface org.mobicents.protocols.api.Association: Use this method only for rejecting anonymous connections from the ServerListener.onNewRemoteConnection() invoking
removeAllResourses() - Method in interface org.mobicents.protocols.api.Management: This method stops and removes all registered servers and associations Management should be started Use this method only for test purposes or after total crashes
removeAssociation(String) - Method in interface org.mobicents.protocols.api.Management: Remove existing Association.
removeCongestionListener(CongestionListener) - Method in interface org.mobicents.protocols.api.Management: Removing CongestionListener.
removeManagementEventListener(ManagementEventListener) - Method in interface org.mobicents.protocols.api.Management: Removing ManagementEventListener.
removeServer(String) - Method in interface org.mobicents.protocols.api.Management: Remove existing Server

S

send(PayloadData) - Method in interface org.mobicents.protocols.api.Association: Send the PayloadData to the peer
Server - Interface in org.mobicents.protocols.api: A wrapper over actual server side Socket
ServerListener - Interface in org.mobicents.protocols.api
setAssociationListener(AssociationListener) - Method in interface org.mobicents.protocols.api.Association: The AssociationListener to be registered for this Association
setBufferSize(int) - Method in interface org.mobicents.protocols.api.Management: Set a sending / receiving buffer size per an association (in bytes).
setCongControl_BackToNormalDelayThreshold_1(double) - Method in interface org.mobicents.protocols.api.Management: For outgoing messages congestion control we need to have 3 thresholds - delays of outgoing messages before it will be sent to IP channel (3 levels - 1, 2, 3).
setCongControl_BackToNormalDelayThreshold_2(double) - Method in interface org.mobicents.protocols.api.Management: For outgoing messages congestion control we need to have 3 thresholds - delays of outgoing messages before it will be sent to IP channel (3 levels - 1, 2, 3).
setCongControl_BackToNormalDelayThreshold_3(double) - Method in interface org.mobicents.protocols.api.Management: For outgoing messages congestion control we need to have 3 thresholds - delays of outgoing messages before it will be sent to IP channel (3 levels - 1, 2, 3).
setCongControl_DelayThreshold_1(double) - Method in interface org.mobicents.protocols.api.Management: For outgoing messages congestion control we need to have 3 thresholds - delays of outgoing messages before it will be sent to IP channel (3 levels - 1, 2, 3).
setCongControl_DelayThreshold_2(double) - Method in interface org.mobicents.protocols.api.Management: For outgoing messages congestion control we need to have 3 thresholds - delays of outgoing messages before it will be sent to IP channel (3 levels - 1, 2, 3).
setCongControl_DelayThreshold_3(double) - Method in interface org.mobicents.protocols.api.Management: For outgoing messages congestion control we need to have 3 thresholds - delays of outgoing messages before it will be sent to IP channel (3 levels - 1, 2, 3).
setConnectDelay(int) - Method in interface org.mobicents.protocols.api.Management: Set the connection delay for client side Association
setMaxConcurrentConnectionsCount(int) - Method in interface org.mobicents.protocols.api.Server: Set the count of concurrent connections that can accept a Server.
setOptionSctpDisableFragments(Boolean) - Method in interface org.mobicents.protocols.api.Management: SCTP option: Enables or disables message fragmentation.
setOptionSctpFragmentInterleave(Integer) - Method in interface org.mobicents.protocols.api.Management: SCTP option: Fragmented interleave controls how the presentation of messages occur for the message receiver.
setOptionSctpInitMaxstreams_MaxInStreams(Integer) - Method in interface org.mobicents.protocols.api.Management: SCTP option: The maximum number of streams requested by the local endpoint during association initialization For an SctpServerChannel this option determines the maximum number of inbound streams accepted sockets will negotiate with their connecting peer.
setOptionSctpInitMaxstreams_MaxOutStreams(Integer) - Method in interface org.mobicents.protocols.api.Management: SCTP option: The maximum number of streams requested by the local endpoint during association initialization For an SctpServerChannel this option determines the maximum number of outbound streams accepted sockets will negotiate with their connecting peer.
setOptionSctpNodelay(Boolean) - Method in interface org.mobicents.protocols.api.Management: SCTP option: Enables or disables a Nagle-like algorithm.
setOptionSoLinger(Integer) - Method in interface org.mobicents.protocols.api.Management: SCTP option: Linger on close if data is present.
setOptionSoRcvbuf(Integer) - Method in interface org.mobicents.protocols.api.Management: SCTP option: The size of the socket receive buffer.
setOptionSoSndbuf(Integer) - Method in interface org.mobicents.protocols.api.Management: SCTP option: The size of the socket send buffer.
setPersistDir(String) - Method in interface org.mobicents.protocols.api.Management: Directory where the XXX.xml will be searched
setServerListener(ServerListener) - Method in interface org.mobicents.protocols.api.Management: The AssociationListener to be registered for this Association
setSingleThread(boolean) - Method in interface org.mobicents.protocols.api.Management: This method is not used more.
setWorkerThreads(int) - Method in interface org.mobicents.protocols.api.Management: This method is not used more.
start() - Method in interface org.mobicents.protocols.api.Management: Start the management.
startAssociation(String) - Method in interface org.mobicents.protocols.api.Management: Start the existing Association
startServer(String) - Method in interface org.mobicents.protocols.api.Management: Start the existing Server
stop() - Method in interface org.mobicents.protocols.api.Management: Stop the management.
stopAnonymousAssociation() - Method in interface org.mobicents.protocols.api.Association: Stop the anonymous association.
stopAssociation(String) - Method in interface org.mobicents.protocols.api.Management: Stop the existing Association
stopServer(String) - Method in interface org.mobicents.protocols.api.Management: Stop the Server.

T

toString() - Method in class org.mobicents.protocols.api.PayloadData

V

valueOf(String) - Static method in enum org.mobicents.protocols.api.AssociationType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.mobicents.protocols.api.IpChannelType: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.mobicents.protocols.api.AssociationType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.mobicents.protocols.api.IpChannelType: Returns an array containing the constants of this enum type, in the order they are declared.

A C G I M O P R S T V