Apama  9.12.0.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
com::apama::engine::EngineConnection Class Reference

EngineConnection encapsulates the information related to a connection between two Apama messaging components. More...

#include <engine_client_cpp.hpp>

Public Member Functions

 EngineConnection (const char *host, int port, bool disconnectSlow, EngineManagement::ConnectMode connectMode, const char *const *channels)
 
 EngineConnection (const char *host, int port, const char *const *channels)
 
virtual const std::vector
< std::string > & 
getChannels () const
 Get the channels associated with this connection. More...
 
virtual const std::string & getHost () const
 Get the host associated with this connection. More...
 
virtual int getPort () const
 Get the port associated with this connection. More...
 
virtual bool getDisconnectSlow () const
 Get the value of disconnectSlow flag associated with this connection. More...
 
virtual
EngineManagement::ConnectMode 
getConnectMode () const
 Get the connection mode associated with this connection. More...
 
virtual ~EngineConnection ()
 Destroy the underlying connection data. More...
 

Friends

std::ostream & operator<< (std::ostream &stream, const EngineConnection &obj)
 Stream output operator for a reference. More...
 
std::ostream & operator<< (std::ostream &stream, const EngineConnection *obj)
 Stream output operator for a pointer. More...
 

Detailed Description

EngineConnection encapsulates the information related to a connection between two Apama messaging components.

Constructor & Destructor Documentation

com::apama::engine::EngineConnection::EngineConnection ( const char *  host,
int  port,
bool  disconnectSlow,
EngineManagement::ConnectMode  connectMode,
const char *const *  channels 
)
inline
Parameters
hostThe remote host to connect to
portThe remote port to connect to
disconnectSlowWhether we should be disconnected if we don't keep up.
connectModethe connection mode to use. Set to CONNECT_LEGACY for single connection, all events delivered to the default channel. Set to CONNECT_PARALLEL for connection per channel and channel values passed through.
channelsAn array of names representing the channels to subscribe to. This is a null-terminated array of pointers to zero-terminated char arrays. If this is null or empty, subscribe to all channels. Note that these channel names should be encoded in UTF-8.
com::apama::engine::EngineConnection::EngineConnection ( const char *  host,
int  port,
const char *const *  channels 
)
inline
Parameters
hostThe remote host to connect to
portThe remote port to connect to
channelsAn array of names representing the channels to subscribe to. This is a null-terminated array of pointers to zero-terminated char arrays. If this is null or empty, subscribe to all channels. Note that these channel names should be encoded in UTF-8.
virtual com::apama::engine::EngineConnection::~EngineConnection ( )
inlinevirtual

Destroy the underlying connection data.

Member Function Documentation

virtual const std::vector<std::string>& com::apama::engine::EngineConnection::getChannels ( ) const
inlinevirtual

Get the channels associated with this connection.

Returns
The list of channels that the downstream component should listen to.
virtual EngineManagement::ConnectMode com::apama::engine::EngineConnection::getConnectMode ( ) const
inlinevirtual

Get the connection mode associated with this connection.

Returns
The connection mode associated with this connection.
virtual bool com::apama::engine::EngineConnection::getDisconnectSlow ( ) const
inlinevirtual

Get the value of disconnectSlow flag associated with this connection.

Returns
returns true if we should be disconnected if this connection is slow.
virtual const std::string& com::apama::engine::EngineConnection::getHost ( ) const
inlinevirtual

Get the host associated with this connection.

Returns
The host of the upstream (even-sending) component
virtual int com::apama::engine::EngineConnection::getPort ( ) const
inlinevirtual

Get the port associated with this connection.

Returns
The port of the upstream (even-sending) component

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  stream,
const EngineConnection obj 
)
friend

Stream output operator for a reference.

std::ostream& operator<< ( std::ostream &  stream,
const EngineConnection obj 
)
friend

Stream output operator for a pointer.


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