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
AssociationListener	getAssociationListener() The AssociationListener set for this Association
java.lang.String	getHostAddress() The host address that underlying socket is bound to
int	getHostPort() The host port that underlying socket is bound to
java.lang.String	getName() Each association has unique name
java.lang.String	getPeerAddress() The peer address that the underlying socket connects to
int	getPeerPort() The peer port that the underlying socket is connected to
java.lang.String	getServerName() Server name if the association is for Server
boolean	isStarted() If this association is started by management
void	send(PayloadData payloadData) Send the PayloadData to the peer
void	setAssociationListener(AssociationListener associationListener) The AssociationListener to be registered for this Association

Method Detail

getName

java.lang.String getName()

Each association has unique name

Returns:

name of association

isStarted

boolean isStarted()

If this association is started by management

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

java.lang.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

java.lang.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

java.lang.String getServerName()

Server name if the association is for Server

Returns:

send

void send(PayloadData payloadData)
          throws java.lang.Exception

Send the PayloadData to the peer

Parameters:

payloadData -

Throws:

java.lang.Exception