FDPeer Class Reference

Represents a Diameter peer. More...

#include <efd.h>

Public Member Functions
	FDPeer ()
	Class constructor. More...
	FDPeer (DiamId_t diamid, uint16_t port=3868)
	Class constructor. More...
	FDPeer (const std::string &diamid, uint16_t port=3868)
	Class constructor. More...
const std::string &	getDiameterId ()
	Retrieves the Diameter ID of the peer. More...
FDPeer &	setDiameterId (DiamId_t diamid)
	Assigns the Diameter ID for this peer object. More...
uint16_t	getPort ()
	Retrieves the IP port for this peer. More...
FDPeer &	setPort (uint16_t v)
	Assigns the IP port for this peer. More...
const EString &	getDestinationHost () const
	Retrieves the distination host for this peer. More...
const EString &	getDestinationRealm () const
	Retrieves the distination realm for this peer. More...
const EString &	setDestinationIp (const char *ip)
	Assigns the peer's IP address. More...
const EString &	setDestinationIp (const std::string &ip)
	Assigns the peer's IP address. More...
const EString &	getDestinationIp () const
	Retrieves the peer's IP address. More...
FDPeerState	getState ()
	Retrieves the peer connection state. More...
Bool	isOpen ()
	Indicates if the connection to the peer is open. More...
Void	add ()
	Adds the peer to freeDiameter. More...

Detailed Description

Represents a Diameter peer.

Constructor & Destructor Documentation

FDPeer() [1/3]

FDPeer::FDPeer

(

)

Class constructor.

FDPeer() [2/3]

FDPeer::FDPeer	(	DiamId_t	diamid,
		uint16_t	port = 3868
	)

Class constructor.

Parameters

diamid	the Diameter ID of the peer.
port	the IP port of the peer.

FDPeer() [3/3]

FDPeer::FDPeer	(	const std::string &	diamid,
		uint16_t	port = 3868
	)

Class constructor.

Parameters

diamid	the Diameter ID of the peer.
port	the IP port of the peer.

Member Function Documentation

add()

Void FDPeer::add

(

)

Adds the peer to freeDiameter.

getDestinationHost()

const EString& FDPeer::getDestinationHost ( ) const

inline

Retrieves the distination host for this peer.

Returns

the destination host for this peer.

getDestinationIp()

const EString& FDPeer::getDestinationIp ( ) const

inline

Retrieves the peer's IP address.

Returns

the peer IP address.

getDestinationRealm()

const EString& FDPeer::getDestinationRealm ( ) const

inline

Retrieves the distination realm for this peer.

Returns

the destination realm for this peer.

getDiameterId()

const std::string& FDPeer::getDiameterId ( )

inline

Retrieves the Diameter ID of the peer.

Returns

the Diameter ID of the peer.

getPort()

uint16_t FDPeer::getPort ( )

inline

Retrieves the IP port for this peer.

Returns

the IP port value.

getState()

FDPeerState FDPeer::getState

(

)

Retrieves the peer connection state.

Returns

the peer connection state.

isOpen()

Bool FDPeer::isOpen ( )

inline

Indicates if the connection to the peer is open.

Returns

True indicates that the connection is open, otherwise False.

setDestinationIp() [1/2]

const EString& FDPeer::setDestinationIp ( const char *  ip )

inline

Assigns the peer's IP address.

Parameters

ip	the peer IP address.

Returns

the peer IP address.

setDestinationIp() [2/2]

const EString& FDPeer::setDestinationIp ( const std::string &  ip )

inline

Assigns the peer's IP address.

Parameters

ip	the peer IP address.

Returns

the peer IP address.

setDiameterId()

FDPeer& FDPeer::setDiameterId ( DiamId_t  diamid )

inline

Assigns the Diameter ID for this peer object.

Parameters

diamid

the Diameter ID of the peer.

Returns

reference to this peer object.

setPort()

FDPeer& FDPeer::setPort ( uint16_t  v )

inline

Assigns the IP port for this peer.

Parameters

v	the new IP Port value to assign.

Returns

reference to this peer object.

---

The documentation for this class was generated from the following files:

• /home/vagrant/share/code/epctools/include/epc/efd.h
• /home/vagrant/share/code/epctools/src/efd.cpp