PubSubBase::PubSubNetworkBackendInterfaceSdk Class Reference

SDK interface for a PubSub network back-end. More...

#include <pubsubnetworkbackendinterface.h>

Inherits PubSubBase::PubSubNetworkBackendInterface.

Inherited by PubSubBase::PubSubNetworkBackendUdp, and PubSubBase::PubSubNetworkBackendUser.

Public Member Functions
virtual int	startUp ()=0
	Start up the network backend.
virtual int	shutDown ()=0
	Shut down the network backend.
virtual int	initSend (WriterGroup *pWriterGroup, pubsub_backend_context *ctx)=0
	Initializes the send context for a WriterGroup. More...
virtual int	initReceive (PubSubConnection *pConnection, pubsub_backend_context *ctx)=0
	Initializes the receive context for a PubSubConnection. More...
virtual int	clear (pubsub_backend_context *ctx)=0
	Clear resources for the context. More...
virtual int	alloc (pubsub_backend_context *ctx)=0
	Allocate the buffer if the buffer is managed by the backend and reused. More...
virtual int	free (pubsub_backend_context *ctx)=0
	Allocate the buffer if the buffer is managed by the backend and reused. More...
virtual int	send (pubsub_backend_context *tx, unsigned int size)=0
	Send a network message for a WriterGroup. More...
virtual void	beginReceive (pubsub_backend_context *rx)=0
	Begin receive of a network message for a PubSubConnection. More...

Additional Inherited Members
Public Types inherited from PubSubBase::PubSubNetworkBackendInterface
enum	PubSubNetworkBackendInterfaceType
	PubSub transport facet reflecting the defined TransportProfileUris.

Detailed Description

SDK interface for a PubSub network back-end.

Member Function Documentation

virtual int PubSubBase::PubSubNetworkBackendInterfaceSdk::alloc ( pubsub_backend_context *  ctx )

pure virtual

Allocate the buffer if the buffer is managed by the backend and reused.

Parameters

[in,out]

ctx

The context

virtual void PubSubBase::PubSubNetworkBackendInterfaceSdk::beginReceive ( pubsub_backend_context *  rx )

pure virtual

Begin receive of a network message for a PubSubConnection.

Parameters

[in,out]

rx

The receive context for the PubSubConnection.

virtual int PubSubBase::PubSubNetworkBackendInterfaceSdk::clear ( pubsub_backend_context *  ctx )

pure virtual

Clear resources for the context.

Parameters

[in,out]

ctx

The context

virtual int PubSubBase::PubSubNetworkBackendInterfaceSdk::free ( pubsub_backend_context *  ctx )

pure virtual

Allocate the buffer if the buffer is managed by the backend and reused.

Parameters

[in,out]

ctx

The context

virtual int PubSubBase::PubSubNetworkBackendInterfaceSdk::initReceive ( PubSubConnection *  pConnection, pubsub_backend_context *  ctx  )

pure virtual

Initializes the receive context for a PubSubConnection.

This call can be used to setup the related connection if necessary, to prepare the user data and other resources in the receive context for further calls related to the receive context

Parameters

[in]	pConnection	The connection management object.
[in,out]	ctx	The receive context for the PubSubConnection.

virtual int PubSubBase::PubSubNetworkBackendInterfaceSdk::initSend ( WriterGroup *  pWriterGroup, pubsub_backend_context *  ctx  )

pure virtual

Initializes the send context for a WriterGroup.

This call can be used to setup the related connection if necessary, to prepare the user data and other resources in the send context for further calls related to the send context.

This method is called multiple times for a WriterGroup if the WriterGroup sends multiple network messages in one publishing interval

Parameters

[in]	pWriterGroup	The writer group management object.
[in,out]	ctx	The send context for the WriterGroup.

virtual int PubSubBase::PubSubNetworkBackendInterfaceSdk::send ( pubsub_backend_context *  tx, unsigned int  size  )

pure virtual

Send a network message for a WriterGroup.

Parameters

[in]	tx	The send context for the WriterGroup.
[in]	size	The size of the data to send.

---

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

• C:/work/uasdkcpp/src/uabase/pubsubbasecpp/pubsubnetworkbackendinterface.h