org.mobicents.protocols.api

Interface AssociationListener

public interface AssociationListener

The listener interface for receiving the underlying socket status and received payload from peer. The class that is interested in receiving data must implement this interface, and the object created with that class is registered with Association

Author:

amit bhayani

Method Summary

Methods

Modifier and Type	Method and Description
void	inValidStreamId(PayloadData payloadData) The stream id set in outgoing PayloadData is invalid.
void	onCommunicationLost(Association association) Invoked when underlying socket lost the connection with peer due to any reason like network between peer's died etc.
void	onCommunicationRestart(Association association) Invoked when the connection with the peer re-started.
void	onCommunicationShutdown(Association association) Invoked when underlying socket is shutdown and connection is ended with peer.
void	onCommunicationUp(Association association, int maxInboundStreams, int maxOutboundStreams) Invoked when underlying socket is open and connection is established with peer.
void	onPayload(Association association, PayloadData payloadData) Invoked when the PayloadData is received from peer

Method Detail

onCommunicationUp

void onCommunicationUp(Association association,
                     int maxInboundStreams,
                     int maxOutboundStreams)

Invoked when underlying socket is open and connection is established with peer. This is expected behavior when management start's the Association

Parameters:

association -

maxInboundStreams - Returns the maximum number of inbound streams that this association supports. Data received on this association will be on stream number s, where 0 <= s < maxInboundStreams(). For TCP socket this value is always 1

maxOutboundStreams - Returns the maximum number of outbound streams that this association supports. Data sent on this association must be on stream number s, where 0 <= s < maxOutboundStreams(). For TCP socket this value is always 1

onCommunicationShutdown

void onCommunicationShutdown(Association association)

Invoked when underlying socket is shutdown and connection is ended with peer. This is expected behavior when management stop's the Association

Parameters:

association -

onCommunicationLost

void onCommunicationLost(Association association)

Invoked when underlying socket lost the connection with peer due to any reason like network between peer's died etc. This is unexpected behavior and the underlying Association should try to re-establish the connection

Parameters:

association -

onCommunicationRestart

void onCommunicationRestart(Association association)

Invoked when the connection with the peer re-started. This is specific to SCTP protocol

Parameters:

association -

onPayload

void onPayload(Association association,
             PayloadData payloadData)

Invoked when the PayloadData is received from peer

Parameters:

association -

payloadData -

inValidStreamId

void inValidStreamId(PayloadData payloadData)

The stream id set in outgoing PayloadData is invalid. This packe will be dropped after calling the listener.

This callback is on same Thread as SelectorThread. Do not delay the process here as it will hold all other IO.

Parameters:

payloadData -