org.jdiameter.client.api.controller
Interface IPeer

All Superinterfaces:

Peer

All Known Subinterfaces:

IPeer

All Known Implementing Classes:

MetaDataImpl.ClientLocalPeer, MetaDataImpl.ServerLocalPeer, PeerImpl, PeerImpl

public interface IPeer
extends Peer

This interface provide additional methods for Peer interface

Author:

erick.svenson@yahoo.com, Alexandre Mendonca , Bartosz Baranowski

Method Summary

void	addConnectionListener(IConnectionListener listener) Add connection state change listener
void	addMessage(IMessage message) Append request to peer request storage map
void	addStateChangeListener(StateChangeListener listener) Add state change listener
long	getHopByHopIdentifier() Return new hop by hop id for new message
int	getRating() Return rating of peer
IStatistic	getStatistic() Return peer statistic
boolean	handleMessage(EventTypes type, IMessage message, java.lang.String key) Put message to peer fsm
boolean	hasValidConnection() Return true if peer has valid connection
boolean	isConnected() Return if peer is connected
IMessage[]	remAllMessage() Clear request storage map
void	remConnectionListener(IConnectionListener listener) Remove connection state change listener
void	remMessage(IMessage message) Remove request from request storage map
void	remStateChangeListener(StateChangeListener listener) Remove state change listener
boolean	sendMessage(IMessage message) Send message to diameter network
void	setRealm(java.lang.String realm) Attach peer to realm

Methods inherited from interface org.jdiameter.api.Peer

addPeerStateListener, connect, disconnect, getCommonApplications, getFirmware, getIPAddresses, getProductName, getRealmName, getState, getUri, getVendorId, removePeerStateListener

Method Detail

getRating

int getRating()

Return rating of peer

Returns:

int value

getHopByHopIdentifier

long getHopByHopIdentifier()

Return new hop by hop id for new message

Returns:

new hop by hop id

addMessage

void addMessage(IMessage message)

Append request to peer request storage map

Parameters:

message - request instance

remMessage

void remMessage(IMessage message)

Remove request from request storage map

Parameters:

message - request instance

remAllMessage

IMessage[] remAllMessage()

Clear request storage map

handleMessage

boolean handleMessage(EventTypes type,
                      IMessage message,
                      java.lang.String key)
                      throws TransportException,
                             OverloadException,
                             InternalException

Put message to peer fsm

Parameters:

message - request instance

Returns:

true if message will be set to FSM

Throws:

TransportException

OverloadException

InternalException

sendMessage

boolean sendMessage(IMessage message)
                    throws TransportException,
                           OverloadException,
                           InternalException

Send message to diameter network

Parameters:

message - request instance

Returns:

true if message will be set to FSM

Throws:

TransportException

OverloadException

InternalException

hasValidConnection

boolean hasValidConnection()

Return true if peer has valid connection

Returns:

true if peer has valid connection

setRealm

void setRealm(java.lang.String realm)

Attach peer to realm

Parameters:

realm - realm name

addStateChangeListener

void addStateChangeListener(StateChangeListener listener)

Add state change listener

Parameters:

listener - listener instance

remStateChangeListener

void remStateChangeListener(StateChangeListener listener)

Remove state change listener

Parameters:

listener - listener instance

addConnectionListener

void addConnectionListener(IConnectionListener listener)

Add connection state change listener

Parameters:

listener - listener instance

remConnectionListener

void remConnectionListener(IConnectionListener listener)

Remove connection state change listener

Parameters:

listener - listener instance

getStatistic

IStatistic getStatistic()

Return peer statistic

Returns:

peer statistic

isConnected

boolean isConnected()

Return if peer is connected

Returns:

is peer connected