anna::diameter::comm::Server Class Reference

#include <Server.hpp>

Public Member Functions
	Server (int maxClientSessions=1)
virtual	~Server ()
void	addClientSession (int socketId) noexcept(false)
void	setClassCodeTimeout (const ClassCode::_v v, const anna::Millisecond &millisecond)
bool	bind () noexcept(false)
void	raiseAutoRecovery (bool autoRecovery=true) noexcept(false)
bool	send (const Message *, int socketId=-1) noexcept(false)
bool	send (const Message &message, int socketId=-1) noexcept(false)
ClientSession *	getLastUsedResource () const
bool	broadcast (const Message *) noexcept(false)
bool	broadcast (const Message &message) noexcept(false)
void	close () noexcept(false)
const Entity *	getParent () const
bool	isAvailable () const
std::vector< ClientSession * >::iterator	begin ()
std::vector< ClientSession * >::iterator	end ()
std::vector< ClientSession * >::const_iterator	begin () const
std::vector< ClientSession * >::const_iterator	end () const
int	getNumberOfClientSessions () const
int	getMaxClientSessions () const
void	setMaxClientSessions (int maxClientSessions)
const std::string &	getAddress () const
int	getPort () const
std::string	socketAsString () const
const anna::Millisecond &	getLastIncomingActivityTime () const
const anna::Millisecond &	getLastOutgoingActivityTime () const
int	getOTARequests () const
bool	idle () const
void	hide ()
void	show ()
bool	hidden () const
bool	shown () const
std::string	asString () const
anna::xml::Node *	asXML (anna::xml::Node *parent) const
void	updateProcessingTimeStatisticConcept (const double &value, const anna::diameter::CommandId &cid)
void	updateReceivedMessageSizeStatisticConcept (const double &value, const anna::diameter::CommandId &cid)

Protected Member Functions
virtual void	eventPeerShutdown (const ClientSession *)
virtual void	eventRequestRetransmission (const ClientSession *, Message *request)
virtual void	eventResponse (const Response &response, const anna::diameter::comm::OriginHost *myNode) noexcept(false)
virtual void	eventRequest (ClientSession *clientSession, const anna::DataBlock &request, const anna::diameter::comm::OriginHost *myNode) noexcept(false)
virtual void	eventUnknownResponse (ClientSession *clientSession, const anna::DataBlock &response, const anna::diameter::comm::OriginHost *myNode) noexcept(false)
virtual void	eventDPA (ClientSession *clientSession, const anna::DataBlock &response, const anna::diameter::comm::OriginHost *myNode) noexcept(false)

Friends
class	Engine
class	ClientSession

Detailed Description

Diameter server with 1..N connections.

Constructor & Destructor Documentation

Server()

anna::diameter::comm::Server::Server ( int  maxClientSessions = 1 )

inline

Default constructor.

Parameters

maxClientSessions

Maximum number of client-sessions managed by the server. Default is 1 (monoconnection server). The value -1, means no limit to add client-sessions.

: a_maxClientSessions(maxClientSessions) { initialize(); }

~Server()

virtual anna::diameter::comm::Server::~Server ( )

inlinevirtual

Destructor

{;}

Member Function Documentation

addClientSession()

void anna::diameter::comm::Server::addClientSession ( int  socketId )

noexcept

Add a server to the entity and create all the client-sessions configured at #setSocketsPerDiameterServer within that server.

Parameters

socketId

Diameter socket identifier within the server.

asString()

std::string anna::diameter::comm::Server::asString

(

)

const

Class string representation

Returns

String with relevant information for this instance.

asXML()

anna::xml::Node* anna::diameter::comm::Server::asXML

(

anna::xml::Node *

parent

)

const

Class xml representation

Parameters

parent

Parent XML node on which hold this instance information.

Returns

XML document with relevant information for this instance.

begin() [1/2]

std::vector<ClientSession*>::iterator anna::diameter::comm::Server::begin ( )

inline

{ return a_clientSessions.begin(); }

begin() [2/2]

std::vector<ClientSession*>::const_iterator anna::diameter::comm::Server::begin ( ) const

inline

{ return a_clientSessions.begin(); }

bind()

bool anna::diameter::comm::Server::bind ( )

noexcept

Binds server client-sessions.

Returns

Returns true if all client-session were successfully bound

broadcast() [1/2]

bool anna::diameter::comm::Server::broadcast ( const Message *  )

noexcept

Sent a message to all the server client-sessions (socketId's) for multiple client client-sessions functionality. It is used, i.e., in Disconnect-Peer-Request procedure over a certain server. Returns true (success) only when broadcast is success over all the server client-sessions. If any client-session fails, then false is returned. Broadcast try to send all over the resources in spite of any fail.

broadcast() [2/2]

bool anna::diameter::comm::Server::broadcast ( const Message &  message )

inlinenoexcept

{ return broadcast(&message); }

Here is the call graph for this function:

close()

void anna::diameter::comm::Server::close ( )

inlinenoexcept

Close all the server client-sessions. Depending on client-session configuration ('OnDisconnect' behaviour), pending answers will be wait (graceful) or ignored (immediate-abrupt close). Resources are not destroyed.

{ close(false /* no destroy */); }

Here is the call graph for this function:

end() [1/2]

std::vector<ClientSession*>::iterator anna::diameter::comm::Server::end ( )

inline

{ return a_clientSessions.end(); }

end() [2/2]

std::vector<ClientSession*>::const_iterator anna::diameter::comm::Server::end ( ) const

inline

{ return a_clientSessions.end(); }

eventDPA()

virtual void anna::diameter::comm::Server::eventDPA ( ClientSession *  clientSession, const anna::DataBlock &  response, const anna::diameter::comm::OriginHost *  myNode  )

protectedvirtualnoexcept

Handler for diameter server (client-session) Disconnect-Peer-Answer messages

Parameters

clientSession	ClientSession from which request has been received
response	Answer data block object without context match

eventPeerShutdown()

virtual void anna::diameter::comm::Server::eventPeerShutdown ( const ClientSession *  )

protectedvirtual

Handler about event break connection from diameter server (client-session) over this entity.

When notified, ANNA.diameter.comm generates an diameter::comm::Entity::eventResponse for every request with pending answers.

eventRequest()

virtual void anna::diameter::comm::Server::eventRequest ( ClientSession *  clientSession, const anna::DataBlock &  request, const anna::diameter::comm::OriginHost *  myNode  )

protectedvirtualnoexcept

Handler for diameter server (client-session) requests

Parameters

clientSession	ClientSession from which request has been received
request	Diameter request message received

eventRequestRetransmission()

virtual void anna::diameter::comm::Server::eventRequestRetransmission ( const ClientSession *  , Message *  request  )

protectedvirtual

Handler about a request retransmission over the session.

Parameters

request

Message retransmitted

eventResponse()

virtual void anna::diameter::comm::Server::eventResponse ( const Response &  response, const anna::diameter::comm::OriginHost *  myNode  )

protectedvirtualnoexcept

Handler for diameter server (client-session) responses

Parameters

response

Answer container object for corresponding diameter request

eventUnknownResponse()

virtual void anna::diameter::comm::Server::eventUnknownResponse ( ClientSession *  clientSession, const anna::DataBlock &  response, const anna::diameter::comm::OriginHost *  myNode  )

protectedvirtualnoexcept

Handler for diameter server (client-session) responses out of context

Parameters

clientSession	ClientSession from which request has been received
response	Answer data block object without context match

getAddress()

const std::string& anna::diameter::comm::Server::getAddress ( ) const

inline

Diameter server address (IP or hostname)

Returns

Diameter server address.

{ return a_socket.first; }

getLastIncomingActivityTime()

const anna::Millisecond& anna::diameter::comm::Server::getLastIncomingActivityTime ( ) const

inline

Gets the timestamp for last incoming activity over the server.

Returns

Last incoming activity timestamp.

{ return a_lastIncomingActivityTime; }

getLastOutgoingActivityTime()

const anna::Millisecond& anna::diameter::comm::Server::getLastOutgoingActivityTime ( ) const

inline

Gets the timestamp for last outgoing activity over the server.

Returns

Last outgoing activity timestamp.

{ return a_lastOutgoingActivityTime; }

getLastUsedResource()

ClientSession* anna::diameter::comm::Server::getLastUsedResource ( ) const

inline

Gets the last used resource (client session) during sending. Broadcast doesn't updates this information.

{ return (a_lastUsedResource); }

getMaxClientSessions()

int anna::diameter::comm::Server::getMaxClientSessions ( ) const

inline

{ return a_maxClientSessions; }

getNumberOfClientSessions()

int anna::diameter::comm::Server::getNumberOfClientSessions ( ) const

inline

{ return a_clientSessions.size(); }

getOTARequests()

int anna::diameter::comm::Server::getOTARequests

(

)

const

Gets the number of requests messages over-the-air.

Returns

OTA messages.

getParent()

const Entity* anna::diameter::comm::Server::getParent ( ) const

inline

Diameter parent entity.

Returns

Diameter parent entity.

{ return a_parent; }

getPort()

int anna::diameter::comm::Server::getPort ( ) const

inline

Diameter server port.

Returns

Diameter server port.

{ return a_socket.second; }

hidden()

bool anna::diameter::comm::Server::hidden

(

)

const

Returns true when all its client session resources are hidden for application messages delivery

hide()

void anna::diameter::comm::Server::hide

(

)

Deny resources for delivery restriction. Deny all its client sessions

idle()

bool anna::diameter::comm::Server::idle ( ) const

inline

Returns idle state (no pending answers).

Returns

Idle state.

{ return (getOTARequests() == 0); }

isAvailable()

bool anna::diameter::comm::Server::isAvailable ( ) const

inline

Returns true when any of the server client-sessions is Bound. False when all not-bound.

{ return a_available; }

raiseAutoRecovery()

void anna::diameter::comm::Server::raiseAutoRecovery ( bool  autoRecovery = true )

noexcept

Propagate auto recovery configuration to client-sessions within server

Parameters

autoRecovery

Auto recovery indicator. True by default.

send() [1/2]

bool anna::diameter::comm::Server::send ( const Message *  , int  socketId = -1  )

noexcept

send() [2/2]

bool anna::diameter::comm::Server::send ( const Message &  message, int  socketId = -1  )

inlinenoexcept

{ return send(&message, socketId); }

Here is the call graph for this function:

setClassCodeTimeout()

void anna::diameter::comm::Server::setClassCodeTimeout	(	const ClassCode::_v	v,
		const anna::Millisecond &	millisecond
	)

Set timeout to consider failed a request.

Parameters

v	Requests class code.
millisecond	Milliseconds wait before considering the requests failed.

Timers are internally managed and automatically activated.

setMaxClientSessions()

void anna::diameter::comm::Server::setMaxClientSessions ( int  maxClientSessions )

inline

{ a_maxClientSessions = maxClientSessions; }

show()

void anna::diameter::comm::Server::show

(

)

Allow resource for delivery permission. Allow all its client sessions

shown()

bool anna::diameter::comm::Server::shown

(

)

const

Returns true when all its client session resources are shown for application messages delivery

socketAsString()

std::string anna::diameter::comm::Server::socketAsString

(

)

const

Server presentation as 'ADDRESS:PORT'

updateProcessingTimeStatisticConcept()

void anna::diameter::comm::Server::updateProcessingTimeStatisticConcept	(	const double &	value,
		const anna::diameter::CommandId &	cid
	)

updateReceivedMessageSizeStatisticConcept()

void anna::diameter::comm::Server::updateReceivedMessageSizeStatisticConcept	(	const double &	value,
		const anna::diameter::CommandId &	cid
	)

Friends And Related Function Documentation

ClientSession

friend class ClientSession

friend

Engine

friend class Engine

friend

---

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

• /tmp/anna/include/anna/diameter.comm/Server.hpp