org.mobicents.protocols.api

Interface Association

public interface Association

A protocol relationship between endpoints

The implementation of this interface is actual wrapper over Socket that know's how to communicate with peer. The user of Association shouldn't care if the underlying Socket is client or server side

Author:

amit bhayani

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptAnonymousAssociation(AssociationListener associationListener) Use this method only for accepting anonymous connections from the ServerListener.onNewRemoteConnection() invoking
AssociationListener	getAssociationListener() The AssociationListener set for this Association
AssociationType	getAssociationType() Return the type of Association CLIENT or SERVER
io.netty.buffer.ByteBufAllocator	getByteBufAllocator() Return ByteBufAllocator if the underlying Channel is netty or null if not
int	getCongestionLevel() Return the last measured Congestion Level at the sending direction
String[]	getExtraHostAddresses() When SCTP multi-homing configuration extra IP addresses are here
String	getHostAddress() The host address that underlying socket is bound to
int	getHostPort() The host port that underlying socket is bound to
IpChannelType	getIpChannelType() Return the Association channel type TCP or SCTP
String	getName() Each association has unique name
String	getPeerAddress() The peer address that the underlying socket connects to
int	getPeerPort() The peer port that the underlying socket is connected to
String	getServerName() Server name if the association is for Server
boolean	isConnected() If this association up (connection is started and established)
boolean	isStarted() If this association is started by management
boolean	isUp() If this association up (connection is established)
void	rejectAnonymousAssociation() Use this method only for rejecting anonymous connections from the ServerListener.onNewRemoteConnection() invoking
void	send(PayloadData payloadData) Send the PayloadData to the peer
void	setAssociationListener(AssociationListener associationListener) The AssociationListener to be registered for this Association
void	stopAnonymousAssociation() Stop the anonymous association.

Method Detail

getIpChannelType

IpChannelType getIpChannelType()

Return the Association channel type TCP or SCTP

Returns:

getAssociationType

AssociationType getAssociationType()

Return the type of Association CLIENT or SERVER

Returns:

getName

String getName()

Each association has unique name

Returns:

name of association

isStarted

boolean isStarted()

If this association is started by management

Returns:

isConnected

boolean isConnected()

If this association up (connection is started and established)

Returns:

isUp

boolean isUp()

If this association up (connection is established)

Returns:

getAssociationListener

AssociationListener getAssociationListener()

The AssociationListener set for this Association

Returns:

setAssociationListener

void setAssociationListener(AssociationListener associationListener)

The AssociationListener to be registered for this Association

Parameters:

associationListener -

getHostAddress

String getHostAddress()

The host address that underlying socket is bound to

Returns:

getHostPort

int getHostPort()

The host port that underlying socket is bound to

Returns:

getPeerAddress

String getPeerAddress()

The peer address that the underlying socket connects to

Returns:

getPeerPort

int getPeerPort()

The peer port that the underlying socket is connected to

Returns:

getServerName

String getServerName()

Server name if the association is for Server

Returns:

getExtraHostAddresses

String[] getExtraHostAddresses()

When SCTP multi-homing configuration extra IP addresses are here

Returns:

send

void send(PayloadData payloadData)
          throws Exception

Send the PayloadData to the peer

Parameters:

payloadData -

Throws:

Exception

getByteBufAllocator

io.netty.buffer.ByteBufAllocator getByteBufAllocator()
                                                     throws Exception

Return ByteBufAllocator if the underlying Channel is netty or null if not

Returns:

Throws:

Exception

getCongestionLevel

int getCongestionLevel()

Return the last measured Congestion Level at the sending direction

Returns:

acceptAnonymousAssociation

void acceptAnonymousAssociation(AssociationListener associationListener)
                                throws Exception

Use this method only for accepting anonymous connections from the ServerListener.onNewRemoteConnection() invoking

Parameters:

associationListener -

Throws:

Exception

rejectAnonymousAssociation

void rejectAnonymousAssociation()

Use this method only for rejecting anonymous connections from the ServerListener.onNewRemoteConnection() invoking

stopAnonymousAssociation

void stopAnonymousAssociation()
                              throws Exception

Stop the anonymous association. The connection will be closed and we will not reuse this association This can be applied only for anonymous association, other associations must be stopped by Management.stopAssociation(String assocName)

Throws:

Exception