Wombat::MamaInbox

A class for processing point-to-point messaging

Inherits from Wombat.MamaWrapper, IDisposable

Public Functions

	Name
	MamaInbox() Construct an inbox.
void	create(MamaTransport transport, MamaQueue queue, MamaInboxCallback callback, object closure) Creates an inbox and stores at the address specified by the calling client.
void	create(MamaTransport transport, MamaQueue queue, MamaInboxCallback callback) Creates an inbox and stores at the address specified by the calling client.
void	create(MamaTransport transport, MamaInboxCallback callback, object closure) Creates an inbox and stores at the address specified by the calling client. Uses a default queue. This functionality is no longer supported.
void	destroy() A synonym to the MamaWrapper.Dispose method.
object	getClosure() Returns the user supplied data passed to create.

	Name
virtual override MamaStatus.mamaStatus	DestroyNativePeer() Implements the destruction of the underlying peer object. MamaWrapper.DestroyNativePeer

Public Functions inherited from Wombat.MamaWrapper

	Name
void	Dispose() Destroys the underlying peer object and unbinds the wrapper from it.
void	setNativeHandle(IntPtr nHandle) Sets the native handle of the native peer object. Should only be used by subclasses and in the same assembly.

Protected Functions inherited from Wombat.MamaWrapper

	Name
	MamaWrapper() Constructs a new wrapper object but doesn’t create it. If the object is not explicitly disposed it will remain registered for finalization and will attempt the destroy the native peer object when finalized.
	MamaWrapper(IntPtr nativeHandle) Constructs a managed wrapper from an existing native peer. The peer object will not be automatically finalized
virtual void	Dispose(bool disposing, bool destroyNativeHandle =true) The actual implementation of Dispose - called by both the Dispose method and the finalizer.
virtual void	OnDispose()

Protected Attributes inherited from Wombat.MamaWrapper

	Name
IntPtr	nativeHandle the handle to the native peer object

MamaInbox()

Construct an inbox.

void create(
    MamaTransport transport,
    MamaQueue queue,
    MamaInboxCallback callback,
    object closure
)

Creates an inbox and stores at the address specified by the calling client.

Parameters:

transport The mamaTransport being used.
queue Optional mamaQueue. Will use default queue if null.
callback A callback interface invoked in response to a p2p message being received or when an error is encountered during p2p messaging.
closure User supplied data

void create(
    MamaTransport transport,
    MamaQueue queue,
    MamaInboxCallback callback
)

Creates an inbox and stores at the address specified by the calling client.

Parameters:

transport The mamaTransport being used.
queue Optional mamaQueue. Will use default queue if null.
callback A callback interface invoked in response to a p2p message being received or when an error is encountered during p2p messaging.

void create(
    MamaTransport transport,
    MamaInboxCallback callback,
    object closure
)

Creates an inbox and stores at the address specified by the calling client. Uses a default queue. This functionality is no longer supported.

Parameters:

transport The mamaTransport being used.
callback A callback interface invoked in response to a p2p message being received or hen an error is encountered during p2p messaging.
closure User supplied data.

void destroy()

A synonym to the MamaWrapper.Dispose method.

object getClosure()

Returns the user supplied data passed to create.

Return: The user supplied data passed to create.

virtual override MamaStatus.mamaStatus DestroyNativePeer()

Implements the destruction of the underlying peer object. MamaWrapper.DestroyNativePeer

Reimplements: Wombat::MamaWrapper::DestroyNativePeer

Updated on 2023-03-31 at 15:29:32 +0100