SST::Core::Interprocess::TunnelDef< ShareDataType, MsgType > Class Template Reference

This class defines a shared-memory region between a master process and one or more child processes Region has three data structures: More...

#include <tunneldef.h>

Public Member Functions
	TunnelDef (size_t numBuffers, size_t bufferSize, uint32_t expectedChildren)
	Create a new tunnel.
	TunnelDef (void *sPtr)
	Access an existing tunnel Child creates the TunnelDef, reads the shmSize, and then resizes its map accordingly.
uint32_t	initialize (void *sPtr)
	Finish setting up a tunnel once the manager knows the correct size of the tunnel and has mmap'd a large enough region for it.
virtual	~TunnelDef ()
	Destructor.
void	shutdown ()
	Clean up a region.
size_t	getTunnelSize ()
	return size of tunnel
ShareDataType *	getSharedData ()
	return a pointer to the ShareDataType region
void	writeMessage (size_t buffer, const MsgType &command)
	Write data to buffer, blocks until space is available.
MsgType	readMessage (size_t buffer)
	Read data from buffer, blocks until message received.
bool	readMessageNB (size_t buffer, MsgType *result)
	Read data from buffer, non-blocking.
void	clearBuffer (size_t buffer)
	Empty the messages in a buffer.
bool	isMaster ()
	return whether this is a master-side tunnel or a child

Protected Member Functions
size_t	getNumBuffers ()
	Return the number of buffers.

Protected Attributes
ShareDataType *	sharedData
	Pointer to the Shared Data Region.

Detailed Description

template<typename ShareDataType, typename MsgType>
class SST::Core::Interprocess::TunnelDef< ShareDataType, MsgType >

This class defines a shared-memory region between a master process and one or more child processes Region has three data structures:

• internal bookkeeping (InternalSharedData),
• user defined shared data (ShareDataType)
• multiple circular-buffer queues with entries of type MsgType

Template Parameters

ShareDataType	Type to put in the shared data region
MsgType	Type of messages being sent in the circular buffers

Constructor & Destructor Documentation

TunnelDef() [1/2]

template<typename ShareDataType, typename MsgType>

SST::Core::Interprocess::TunnelDef< ShareDataType, MsgType >::TunnelDef ( size_t numBuffers, size_t bufferSize, uint32_t expectedChildren )

inline

Create a new tunnel.

Parameters

numBuffers	Number of buffers for which we should tunnel
bufferSize	How large each buffer should be
expectedChildren	Number of child processes that will connect to this tunnel

TunnelDef() [2/2]

template<typename ShareDataType, typename MsgType>

SST::Core::Interprocess::TunnelDef< ShareDataType, MsgType >::TunnelDef ( void * sPtr )

inlineexplicit

Access an existing tunnel Child creates the TunnelDef, reads the shmSize, and then resizes its map accordingly.

Parameters

sPtr	Location of shared memory region

Member Function Documentation

clearBuffer()

template<typename ShareDataType, typename MsgType>

void SST::Core::Interprocess::TunnelDef< ShareDataType, MsgType >::clearBuffer ( size_t buffer )

inline

Empty the messages in a buffer.

Parameters

buffer

which buffer to empty

initialize()

template<typename ShareDataType, typename MsgType>

uint32_t SST::Core::Interprocess::TunnelDef< ShareDataType, MsgType >::initialize ( void * sPtr )

inline

Finish setting up a tunnel once the manager knows the correct size of the tunnel and has mmap'd a large enough region for it.

Parameters

sPtr	Location of shared memory region returns number of children left to attach

readMessage()

template<typename ShareDataType, typename MsgType>

MsgType SST::Core::Interprocess::TunnelDef< ShareDataType, MsgType >::readMessage ( size_t buffer )

inline

Read data from buffer, blocks until message received.

Parameters

buffer

which buffer to read from return the message

readMessageNB()

template<typename ShareDataType, typename MsgType>

bool SST::Core::Interprocess::TunnelDef< ShareDataType, MsgType >::readMessageNB ( size_t buffer, MsgType * result )

inline

Read data from buffer, non-blocking.

Parameters

buffer	which buffer to read from
result	pointer to return read message at return whether a message was read

writeMessage()

template<typename ShareDataType, typename MsgType>

void SST::Core::Interprocess::TunnelDef< ShareDataType, MsgType >::writeMessage ( size_t buffer, const MsgType & command )

inline

Write data to buffer, blocks until space is available.

Parameters

buffer	which buffer index to write to
command	message to write to buffer

---

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

• src/sst/core/interprocess/tunneldef.h