fipa::services::transports::udt::IncomingConnection Class Reference

A unidirectional, incoming connection to receive incoming messages. More...

#include <IncomingConnection.hpp>

Inheritance diagram for fipa::services::transports::udt::IncomingConnection:

Public Types
typedef boost::shared_ptr< IncomingConnection >	Ptr

Public Member Functions
	IncomingConnection ()
	~IncomingConnection ()
	IncomingConnection (const UDTSOCKET &socket, const std::string &ip, uint16_t port)
const UDTSOCKET &	getSocket () const
bool	operator== (const IncomingConnection &connection) const
int	receiveMessage (char *buffer, size_t size) const
Public Member Functions inherited from fipa::services::transports::Connection
	Connection ()
	Connection (const std::string &ip, uint16_t port, const std::string &protocol="udt")
	Connection (const Address &address)
uint16_t	getPort () const
std::string	getIP () const
Address	getAddress () const
bool	operator== (const Connection &other) const

Additional Inherited Members
Protected Attributes inherited from fipa::services::transports::Connection
Address	mAddress

Detailed Description

A unidirectional, incoming connection to receive incoming messages.

Member Typedef Documentation

Ptr

typedef boost::shared_ptr<IncomingConnection> fipa::services::transports::udt::IncomingConnection::Ptr

Constructor & Destructor Documentation

IncomingConnection() [1/2]

fipa::services::transports::udt::IncomingConnection::IncomingConnection

(

)

~IncomingConnection()

fipa::services::transports::udt::IncomingConnection::~IncomingConnection

(

)

IncomingConnection() [2/2]

fipa::services::transports::udt::IncomingConnection::IncomingConnection	(	const UDTSOCKET &	socket,
		const std::string &	ip,
		uint16_t	port
	)

Member Function Documentation

getSocket()

const UDTSOCKET& fipa::services::transports::udt::IncomingConnection::getSocket ( ) const

inline

Get underlying UDTSOCKET

Returns

socket

operator==()

bool fipa::services::transports::udt::IncomingConnection::operator== ( const IncomingConnection &  connection ) const

inline

Equals operator based on the connection address

Returns

true if the connection address is the same for both connections, false otherwise

receiveMessage()

int fipa::services::transports::udt::IncomingConnection::receiveMessage	(	char *	buffer,
		size_t	size
	)		const

Receive a message

Parameters

buffer	to store message
size	size of the buffer

Returns

number of received bytes

---

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

• /build/rock-master-18.09-multiagent-fipa-services-0.20171213/src/transports/udt/IncomingConnection.hpp
• /build/rock-master-18.09-multiagent-fipa-services-0.20171213/src/transports/udt/IncomingConnection.cpp