org.jdiameter.api

Interface Peer

public interface Peer

Peer contains everything that is worth knowing about a peer and define some operation for working with this peer.

Version:

1.5.1 Final

Author:

erick.svenson@yahoo.com, artem.litvinov@gmail.com

Method Summary

Methods

Modifier and Type	Method and Description
void	addPeerStateListener(PeerStateListener listener) Append peer state change listener to the peer manager
void	connect() Establishes a connection towards a remote peer.
void	disconnect(int disconnectCause) Close the connection to the peer.
Set<ApplicationId>	getCommonApplications()
long	getFirmware()
InetAddress[]	getIPAddresses()
String	getProductName()
String	getRealmName()
<E> E	getState(Class<E> enumc) All implementations must support PeerState interface as argument
URI	getUri()
long	getVendorId()
void	removePeerStateListener(PeerStateListener listener) Remove peer state change listener from the peer manager

Method Detail

connect

void connect()
             throws InternalException,
                    IOException,
                    IllegalDiameterStateException

Establishes a connection towards a remote peer.

Throws:

IllegalDiameterStateException

InternalException

IOException

disconnect

void disconnect(int disconnectCause)
                throws InternalException,
                       IllegalDiameterStateException

Close the connection to the peer.

Throws:

IllegalDiameterStateException

InternalException

getState

<E> E getState(Class<E> enumc)

All implementations must support PeerState interface as argument

Returns:

state of peer

getUri

URI getUri()

Returns:

URI of peer

getIPAddresses

InetAddress[] getIPAddresses()

Returns:

array of peer ip addresses

getRealmName

String getRealmName()

Returns:

Realm name of peer

getVendorId

long getVendorId()

Returns:

vendor id of peer stack implementation

getProductName

String getProductName()

Returns:

product name of peer stack implementation

getFirmware

long getFirmware()

Returns:

firmware version of peer stack implementation

getCommonApplications

Set<ApplicationId> getCommonApplications()

Returns:

set of common Application-id of peer;

addPeerStateListener

void addPeerStateListener(PeerStateListener listener)

Append peer state change listener to the peer manager

Parameters:

listener - listener instance

removePeerStateListener

void removePeerStateListener(PeerStateListener listener)

Remove peer state change listener from the peer manager

Parameters:

listener - listener instance