Introduction
Documentation Home What is OpenMAMA? Supported Platforms Versioning
Tutorials
1. Quick Start 2. Using MAMA Resource Pool
User Guides
Installing OpenMAMA OpenMAMA Developer's Guide OpenMAMDA Developer's Guide API Reference Docs Portable Demo Environment IDE Integration Running Example Apps Qpid Bridge Raising Issues Performance Testing Vulnerability Reporting
Contributor Guides
Contributing to Documentation Third Party Repository Building From Source Bridge Building Documentation Bridge Developer FAQ Bridge Incorporation Guidelines Coding Standards Dynamic Bridge Loading Long Lived Feature Branches Release Process Submission Process Unit Testing
RFC Documents
Open Closed Process Template
Classes Files

Wombat::MamaWrapper

Base class for all wrapped native objects. Provides common facilities to the base classes.

Inherits from IDisposable

Inherited by Wombat.MamaBasicSubscription, Wombat.MamaBridge, Wombat.MamaClientProfile, Wombat.MamaDictionary, Wombat.MamaFieldDescriptor, Wombat.MamaFtMember, Wombat.MamaInbox, Wombat.MamaIo, Wombat.MamaMsg, Wombat.MamaMsgField, Wombat.MamaMsgIterator, Wombat.MamaPayloadBridge, Wombat.MamaPrice, Wombat.MamaPublisher, Wombat.MamaQueue, Wombat.MamaSource, Wombat.MamaSourceGroup, Wombat.MamaSourceGroupManager, Wombat.MamaSourceManager, Wombat.MamaSymbolMapFile, Wombat.MamaTimer, Wombat.MamaTransport

Public Functions

  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

  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 abstract MamaStatus.mamaStatus DestroyNativePeer() =0
Subclasses must do whatever is necessary with the native handle in the overridden method in order to destroy the native peer object. If the destruction went successfully, the overridden method must return MamaStatus.mamaStatus.MAMA_STATUS_OK, or a suitable error code otherwise
virtual void OnDispose()

Protected Attributes

  Name
IntPtr nativeHandle
the handle to the native peer object

Public Functions Documentation

function Dispose

void Dispose()

Destroys the underlying peer object and unbinds the wrapper from it.

function setNativeHandle

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 Documentation

function MamaWrapper

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.

function MamaWrapper

MamaWrapper(
    IntPtr nativeHandle
)

Constructs a managed wrapper from an existing native peer. The peer object will not be automatically finalized

Parameters:

  • nativeHandle The opaque native handle to the peer object

function Dispose

virtual void Dispose(
    bool disposing,
    bool destroyNativeHandle =true
)

The actual implementation of Dispose - called by both the Dispose method and the finalizer.

Parameters:

  • disposing true if the object is being disposed (false if being finalized)

Reimplemented by: Wombat::MamaPublisher::Dispose

function DestroyNativePeer

virtual abstract MamaStatus.mamaStatus DestroyNativePeer() =0

Subclasses must do whatever is necessary with the native handle in the overridden method in order to destroy the native peer object. If the destruction went successfully, the overridden method must return MamaStatus.mamaStatus.MAMA_STATUS_OK, or a suitable error code otherwise

Return: MamaStatus.mamaStatus.MAMA_STATUS_OK on success, one of the MamaStatus.mamaStatus.MAMA_STATUS_OK error codes otherwise

Reimplemented by: Wombat::MamaBasicSubscription::DestroyNativePeer, Wombat::MamaBridge::DestroyNativePeer, Wombat::MamaClientProfile::DestroyNativePeer, Wombat::MamaDictionary::DestroyNativePeer, Wombat::MamaFieldDescriptor::DestroyNativePeer, Wombat::MamaFtMember::DestroyNativePeer, Wombat::MamaInbox::DestroyNativePeer, Wombat::MamaIo::DestroyNativePeer, Wombat::MamaMsgIterator::DestroyNativePeer, Wombat::MamaMsg::DestroyNativePeer, Wombat::MamaMsgField::DestroyNativePeer, Wombat::MamaPayloadBridge::DestroyNativePeer, Wombat::MamaPrice::DestroyNativePeer, Wombat::MamaPublisher::DestroyNativePeer, Wombat::MamaQueue::DestroyNativePeer, Wombat::MamaSource::DestroyNativePeer, Wombat::MamaSourceGroup::DestroyNativePeer, Wombat::MamaSourceGroupManager::DestroyNativePeer, Wombat::MamaSourceManager::DestroyNativePeer, Wombat::MamaSymbolMapFile::DestroyNativePeer, Wombat::MamaTimer::DestroyNativePeer, Wombat::MamaTransport::DestroyNativePeer

function OnDispose

virtual void OnDispose()

Reimplemented by: Wombat::MamaMsg::OnDispose, Wombat::MamaTransport::OnDispose

Protected Attributes Documentation

variable nativeHandle

IntPtr nativeHandle;

the handle to the native peer object

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