com::softwareag::connectivity::PluginHost Class Reference

Interface to support miscellaneous requests from a particular plug-in to the host system. More...

#include <sag_connectivity_plugins.hpp>

Public Member Functions
void	enableReliability (Direction direction)
	Enable reliable messaging for the chain that this plug-in belongs to, in a particular direction i.e. More...
void	enableQueueFlushMessages ()
	Enable notifications about queue flushes. More...
bool	isShuttingDown ()
	Check if host is shutting down. More...

Detailed Description

Interface to support miscellaneous requests from a particular plug-in to the host system.

Since

10.0

Member Function Documentation

enableQueueFlushMessages()

void com::softwareag::connectivity::PluginHost::enableQueueFlushMessages ( )

inline

Enable notifications about queue flushes.

This will cause the host plug-in to send Message::CONTROL_TYPE_QUEUE_FLUSH control messages down the chain.

Queue flush control messages are not supported in chains containing Java plug-ins.

Plug-ins which contain their own queue should call this method and then store the Message::CONTROL_OBJECT values in the queue, destroying them once everything on the queue prior to the control message has been processed to completion.

This method is idempotent. Once enabled for a chain, queue flush messages cannot be disabled.

enableReliability()

void com::softwareag::connectivity::PluginHost::enableReliability ( Direction  direction )

inline

Enable reliable messaging for the chain that this plug-in belongs to, in a particular direction i.e.

TOWARDS_HOST means that the host is expected to acknowledge messages that this plug-in sends towards the host, and TOWARDS_TRANSPORT means that the transport is expected to acknowledge flushes for messages sent from the host.

Must be called before this plug-in attempts to perform any other reliable messaging operations, and before the plug-in has been fully started.

Should be called once for each direction if this chain is performing bi-directional reliable messaging.

isShuttingDown()

bool com::softwareag::connectivity::PluginHost::isShuttingDown ( )

inline

Check if host is shutting down.

---

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

• sag_connectivity_plugins.hpp