Vortex::FACE::Connection< TYPE > Class Template Reference

#include "Connection.hpp"

Inheritance diagram for Vortex::FACE::Connection< TYPE >:

Public Types
typedef Vortex::FACE::smart_ptr_traits< Connection< TYPE > >::shared_ptr	shared_ptr

Public Member Functions
	Connection ()
virtual	~Connection ()
::FACE::CONNECTION_DIRECTION_TYPE	getDirection ()
virtual int32_t	getDomainId () const
std::string	getName ()
::FACE::RETURN_CODE_TYPE	init (Vortex::FACE::ConnectionConfig::shared_ptr cfg)
::FACE::RETURN_CODE_TYPE	parameters (::FACE::CONNECTION_NAME_TYPE &connectionName, ::FACE::TRANSPORT_CONNECTION_STATUS_TYPE &connectionStatus)
::FACE::RETURN_CODE_TYPE	receive (TYPE &message, const ::FACE::TIMEOUT_TYPE &timeout)
::FACE::RETURN_CODE_TYPE	registerCallback (typename ::FACE::Read_Callback< TYPE >::send_event cb, const ::FACE::WAITSET_TYPE &mask)
::FACE::RETURN_CODE_TYPE	send (const TYPE &message, const ::FACE::TIMEOUT_TYPE &timeout)
virtual ::FACE::RETURN_CODE_TYPE	unregisterCallback ()

Static Public Member Functions
static Connection< TYPE >::shared_ptr	get (const ::FACE::CONNECTION_ID_TYPE &connectionId, ::FACE::RETURN_CODE_TYPE &status)

Detailed Description

template<typename TYPE>
class Vortex::FACE::Connection< TYPE >

Definition at line 34 of file Connection.hpp.

Member Typedef Documentation

shared_ptr

template<typename TYPE>

typedef Vortex::FACE::smart_ptr_traits< Connection<TYPE> >::shared_ptr Vortex::FACE::Connection< TYPE >::shared_ptr

Definition at line 37 of file Connection.hpp.

Constructor & Destructor Documentation

Connection()

template<typename TYPE>

Vortex::FACE::Connection< TYPE >::Connection ( )

inline

Definition at line 39 of file Connection.hpp.

~Connection()

template<typename TYPE>

virtual Vortex::FACE::Connection< TYPE >::~Connection ( )

inlinevirtual

Definition at line 49 of file Connection.hpp.

Member Function Documentation

get()

template<typename TYPE>

static Connection<TYPE>::shared_ptr Vortex::FACE::Connection< TYPE >::get ( const ::FACE::CONNECTION_ID_TYPE &  connectionId, ::FACE::RETURN_CODE_TYPE &  status  )

inlinestatic

Definition at line 60 of file Connection.hpp.

getDirection()

::FACE::CONNECTION_DIRECTION_TYPE Vortex::FACE::AnyConnection::getDirection ( )

inherited

getDomainId()

template<typename TYPE>

virtual int32_t Vortex::FACE::Connection< TYPE >::getDomainId ( ) const

inlinevirtual

Implements Vortex::FACE::AnyConnection.

Definition at line 225 of file Connection.hpp.

getName()

std::string Vortex::FACE::AnyConnection::getName ( )

inherited

init()

::FACE::RETURN_CODE_TYPE Vortex::FACE::AnyConnection::init ( Vortex::FACE::ConnectionConfig::shared_ptr  cfg )

inherited

parameters()

::FACE::RETURN_CODE_TYPE Vortex::FACE::AnyConnection::parameters ( ::FACE::CONNECTION_NAME_TYPE &  connectionName, ::FACE::TRANSPORT_CONNECTION_STATUS_TYPE &  connectionStatus  )

inherited

receive()

template<typename TYPE>

::FACE::RETURN_CODE_TYPE Vortex::FACE::Connection< TYPE >::receive ( TYPE &  message, const ::FACE::TIMEOUT_TYPE &  timeout  )

inline

Definition at line 119 of file Connection.hpp.

registerCallback()

template<typename TYPE>

::FACE::RETURN_CODE_TYPE Vortex::FACE::Connection< TYPE >::registerCallback ( typename ::FACE::Read_Callback< TYPE >::send_event  cb, const ::FACE::WAITSET_TYPE &  mask  )

inline

Definition at line 163 of file Connection.hpp.

send()

template<typename TYPE>

::FACE::RETURN_CODE_TYPE Vortex::FACE::Connection< TYPE >::send ( const TYPE &  message, const ::FACE::TIMEOUT_TYPE &  timeout  )

inline

Definition at line 88 of file Connection.hpp.

unregisterCallback()

template<typename TYPE>

virtual ::FACE::RETURN_CODE_TYPE Vortex::FACE::Connection< TYPE >::unregisterCallback ( )

inlinevirtual

Implements Vortex::FACE::AnyConnection.

Definition at line 195 of file Connection.hpp.

---

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

• face/cpp/include/Vortex/FACE/Connection.hpp