ipsdk::tcpip Namespace Reference

Namespace agregating IPSDK TCP/IP network communication routines and classes. More...

Classes
class	Address
	derived class of asio io address for ipsdk::tcpip namespace integration More...
class	CollPeersCB
	Callback class, intended to be used by CollPeers class, and whose methods will be called each time an event associated to CollPeers occurs The user has to inherit from this class if he wants to specify a given behaviour in reaction to these events. More...
class	EndPoint
	serializable overlay of boost::asio::endpoint More...
class	IPSDKCommException
	Exception class for library IPSDKComm. More...
class	SocketDesc
class	SocketGuid
	class describing the endpoints (local and remote) of a peer More...

Typedefs
typedef std::set< tcpip::EndPoint >	EndPointSet
	collection of end points
typedef boost::asio::ip::address_v4	AddressV4
	ip v4 address type
typedef boost::asio::ip::address_v6	AddressV6
	ip v6 address type
typedef boost::function3< void, const Guid &, ipUInt64, bool >	DlvCbFun
	function prototype associated to socket delivery callback
typedef boost::function2< void, const SocketDesc &, const boost::system::error_code & >	CnxLossCbFun
	function prototype associated to socket connection loss callback
typedef boost::shared_ptr< Acceptor >	AcceptorPtr
	typedefs for shared_ptr on main tcpip classes
typedef boost::shared_ptr< AcceptorCB >	AcceptorCBPtr
	typedefs for shared_ptr on main tcpip classes
typedef boost::shared_ptr< Client >	ClientPtr
	typedefs for shared_ptr on main tcpip classes
typedef boost::shared_ptr< CollPeers >	CollPeersPtr
	typedefs for shared_ptr on main tcpip classes
typedef boost::shared_ptr< CollPeersCB >	CollPeersCBPtr
	typedefs for shared_ptr on main tcpip classes
typedef boost::shared_ptr< Peer >	PeerPtr
	typedefs for shared_ptr on main tcpip classes
typedef boost::shared_ptr< Server >	ServerPtr
	typedefs for shared_ptr on main tcpip classes

Enumerations
enum	eIPSDKCommMessage {   eSocketArchiveHdrReadError, eSocketArchiveDataReadError, eSocketArchiveHdrWriteError, eSocketArchiveDataWriteError,   eInvalidArchiveHeader, eInvalidArchiveFooter, eAcceptorThreadName, ePeerReadThreadName,   eServerSocketThreadName, eClientSocketThreadName, eConnectedServerSocketThreadName, eEndPointToString,   eCannotJoinIfExternalIOServiceUsed, eUndefinedPeerType }
	Enumerate describing messages. More...
enum	ePeerType { eUndefined, eClient, eServer }
	Enumerate TCP/IP peer type (client or serveur. More...
enum	eIPAddressType { eV4, eV6 }
	Enumerate TCP/IP ip address type. More...

Functions
IPSDKCOMM_API const std::string &	getIPSDKCommLoggerName ()
	Recovery of logger name associated to library.
IPSDKCOMM_API log4cplus::Logger &	getIPSDKCommLogger ()
	Recovery of logger associated to library.
IPSDKCOMM_API const ipsdk::LogMessageManager &	getIPSDKCommLogMessageManager ()
	Recovery of message manager associated to library.
bool IPSDKCOMM_API	setKeepAliveSettings (boost::asio::ip::tcp::socket &sock, ipUInt32 time, ipUInt32 interval, ipUInt32 nbProbes)
IPSDKCOMM_API bool	operator== (const EndPoint &endPoint1, const EndPoint &endPoint2)
IPSDKCOMM_API bool	operator!= (const EndPoint &endPoint1, const EndPoint &endPoint2)
IPSDKCOMM_API bool	operator< (const EndPoint &endPoint1, const EndPoint &endPoint2)

Detailed Description

Namespace agregating IPSDK TCP/IP network communication routines and classes.

Enumeration Type Documentation

eIPSDKCommMessage

enum ipsdk::tcpip::eIPSDKCommMessage

Enumerate describing messages.

Note

This enumerate is associated to a message map

See also

IPSDK_Message_Map

Enumerator
eSocketArchiveHdrReadError	Error while reading serialization header from socket.
eSocketArchiveDataReadError	Error while reading serialization data from socket.
eSocketArchiveHdrWriteError	Error while writing serialization header to socket.
eSocketArchiveDataWriteError	Error while writing serialization data to socket.
eInvalidArchiveHeader	Invalid archive header, not a valid archive for ipsdk.
eInvalidArchiveFooter	Invalid archive footer, archive may be corrupted.
eAcceptorThreadName	Acceptor #d.
ePeerReadThreadName	SockRead s.
eServerSocketThreadName	Server.
eClientSocketThreadName	Client s.
eConnectedServerSocketThreadName	Server s.
eEndPointToString	s:d
eCannotJoinIfExternalIOServiceUsed	Cannot join if external io_service is used.
eUndefinedPeerType	Error: undefined peer type.

ePeerType

enum ipsdk::tcpip::ePeerType

Enumerate TCP/IP peer type (client or serveur.

Note

This object is associated to a strong enumerate definition

See also

IPSDK_Enum

Enumerator
eUndefined	undefined type
eClient	TCP/IP client.
eServer	TCP/IP server.

eIPAddressType

enum ipsdk::tcpip::eIPAddressType

Enumerate TCP/IP ip address type.

Note

This object is associated to a strong enumerate definition

See also

IPSDK_Enum

Enumerator
eV4	IP v4 TCP/IP address.
eV6	IP v6 TCP/IP address.

Function Documentation

operator==()

IPSDKCOMM_API bool ipsdk::tcpip::operator==	(	const EndPoint &	endPoint1,
		const EndPoint &	endPoint2
	)

operators allowing to compare end points

operator!=()

IPSDKCOMM_API bool ipsdk::tcpip::operator!=	(	const EndPoint &	endPoint1,
		const EndPoint &	endPoint2
	)

operators allowing to compare end points

operator<()

IPSDKCOMM_API bool ipsdk::tcpip::operator<	(	const EndPoint &	endPoint1,
		const EndPoint &	endPoint2
	)

operators allowing to compare end points