Wombat::MamaIo

I/O handler

Inherits from Wombat.MamaWrapper, IDisposable

Public Functions

	Name
	MamaIo() M:Wombat.MamaWrapper.::ctor
void	create(MamaQueue queue, MamaIoCallback action, uint descriptor, mamaIoType ioType, object closure) Create an IO handler.
void	create(MamaQueue queue, MamaIoCallback action, uint descriptor, mamaIoType ioType) create(MamaQueue, MamaIoCallback, uint, mamaIoType, System.Object)
void	create(MamaQueue queue, MamaIoCallback action, long descriptor, mamaIoType ioType, object closure) CLS compliant version of create create(MamaQueue, MamaIoCallback, uint, mamaIoType, System.Object)
void	create(MamaQueue queue, MamaIoCallback action, long descriptor, mamaIoType ioType) CLS compliant version of create create(MamaQueue, MamaIoCallback, uint, mamaIoType, System.Object)
void	destroy() Destroy the IO. A synonym to the MamaWrapper.Dispose method.

Protected Functions

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

Public Properties

	Name
uint	descriptor Get the descriptor.
long	descriptorClsCompliant CLS compliant version of descriptor
object	closure Return the closure for the IO.

Additional inherited members

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

Public Functions Documentation

function MamaIo

MamaIo()

M:Wombat.MamaWrapper.::ctor

function create

void create(
    MamaQueue queue,
    MamaIoCallback action,
    uint descriptor,
    mamaIoType ioType,
    object closure
)

Create an IO handler.

Parameters:

queue The event queue for the io events. null specifies the Mama default queue
action The callback to be invoked when an event occurs.
descriptor Wait for IO on this descriptor.
ioType Wait for occurences of this type.
closure The closure that is passed to the callback.

If the underlying infrastructure does not support the requested mamaIoType, create throws MamaException(MAMA_STATUS_UNSUPPORTED_IO_TYPE). For example, RV only supports READ, WRITE, and EXCEPT. LBM supports all types except ERROR

function create

void create(
    MamaQueue queue,
    MamaIoCallback action,
    uint descriptor,
    mamaIoType ioType
)

create(MamaQueue, MamaIoCallback, uint, mamaIoType, System.Object)

function create

void create(
    MamaQueue queue,
    MamaIoCallback action,
    long descriptor,
    mamaIoType ioType,
    object closure
)

CLS compliant version of create create(MamaQueue, MamaIoCallback, uint, mamaIoType, System.Object)

function create

void create(
    MamaQueue queue,
    MamaIoCallback action,
    long descriptor,
    mamaIoType ioType
)

CLS compliant version of create create(MamaQueue, MamaIoCallback, uint, mamaIoType, System.Object)

function destroy

void destroy()

Destroy the IO. A synonym to the MamaWrapper.Dispose method.

Protected Functions Documentation

function DestroyNativePeer

virtual override MamaStatus.mamaStatus DestroyNativePeer()

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

Reimplements: Wombat::MamaWrapper::DestroyNativePeer

Public Property Documentation

property descriptor

uint descriptor;

Get the descriptor.

property descriptorClsCompliant

long descriptorClsCompliant;

CLS compliant version of descriptor

property closure

object closure;

Return the closure for the IO.

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