com::softwareag::connectivity::chainmanagers::Chain< TRANSPORT > Class Template Reference

Represents a dynamic chain instance, created using ChainManagerHost.createChain. More...

#include <sag_connectivity_chain_managers.hpp>

Public Member Functions
const Chain &	start () const
	Calls start on all of the plug-ins in the chain and connects the chain to receive events. More...
Chain &	start ()
	Calls start on all of the plug-ins in the chain and connects the chain to receive events. More...
void	destroy ()
	Shutdown and destroy a chain. More...
TRANSPORT *	getTransport () const
	Get the transport plug-in at the end of the chain. More...
const std::string &	getChainId ()
	Get the unique identifier of this chain. More...

Detailed Description

template<typename TRANSPORT>
class com::softwareag::connectivity::chainmanagers::Chain< TRANSPORT >

Represents a dynamic chain instance, created using ChainManagerHost.createChain.

Since

10.2.0.0

Author

BSP

Member Function Documentation

destroy()

template<typename TRANSPORT>

void com::softwareag::connectivity::chainmanagers::Chain< TRANSPORT >::destroy

(

)

Shutdown and destroy a chain.

This will result in the transport and any codecs being shutdown and then deleted.

getChainId()

template<typename TRANSPORT>

const std::string& com::softwareag::connectivity::chainmanagers::Chain< TRANSPORT >::getChainId ( )

inline

Get the unique identifier of this chain.

getTransport()

template<typename TRANSPORT>

TRANSPORT* com::softwareag::connectivity::chainmanagers::Chain< TRANSPORT >::getTransport ( ) const

inline

Get the transport plug-in at the end of the chain.

Never returns null. It is an error to call this after the chain has been destroyed.

start() [1/2]

template<typename TRANSPORT>

const Chain& com::softwareag::connectivity::chainmanagers::Chain< TRANSPORT >::start ( ) const

inline

Calls start on all of the plug-ins in the chain and connects the chain to receive events.

Will not return until all start() methods have completed and therefore may block.

If the chain to be created might send events during the start() call then this should not be called from an event receiving thread as a deadlock may occur.

If onApplicationInitialized has already been called then hostReady will be called on the new chain immediately from a background thread. Once onApplicationInitialized has been called the chain will receive any events that were sent to its subscribed channels from after the createChain call onwards.

Returns

this Chain instance (to support fluent call style)

Exceptions

Exception

if an exception is thrown by the start() method of any plug-in in the chain.

start() [2/2]

template<typename TRANSPORT>

Chain& com::softwareag::connectivity::chainmanagers::Chain< TRANSPORT >::start ( )

inline

Calls start on all of the plug-ins in the chain and connects the chain to receive events.

Will not return until all start() methods have completed and therefore may block.

If the chain to be created might send events during the start() call then this should not be called from an event receiving thread as a deadlock may occur.

If onApplicationInitialized has already been called then hostReady will be called on the new chain immediately from a background thread. Once onApplicationInitialized has been called the chain will receive any events that were sent to its subscribed channels from after the createChain call onwards.

Returns

this Chain instance (to support fluent call style)

Exceptions

Exception

if an exception is thrown by the start() method of any plug-in in the chain.

---

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

• sag_connectivity_chain_managers.hpp