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::MamaClientProfile

A class containing various information about the MAMA client

Inherits from Wombat.MamaWrapper, IDisposable

Public Functions

  Name
  MamaClientProfile()
void create()
Create a mamaClientProfile object. Attribute data will be copied into allocated memory.
void createNoCopyData()
Create a mamaClientProfile object. The attribute data will not be copied, only the user supplied pointers to the attributes be stored.
bool getCopyData()
Return whether or not the profile copies attribute data.
void clear()
Clear a mamaClientProfile object.
void setInterfaceVersion(byte id)
Set the ID of a mamaClientProfile object.
byte getInterfaceVersion()
Get the ID of a mamaClientProfile object.
void setUserName(string userName)
Set the user name.
string getUserName()
Get the user name.

Protected Functions

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

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 MamaClientProfile

MamaClientProfile()

function create

void create()

Create a mamaClientProfile object. Attribute data will be copied into allocated memory.

function createNoCopyData

void createNoCopyData()

Create a mamaClientProfile object. The attribute data will not be copied, only the user supplied pointers to the attributes be stored.

function getCopyData

bool getCopyData()

Return whether or not the profile copies attribute data.

function clear

void clear()

Clear a mamaClientProfile object.

function setInterfaceVersion

void setInterfaceVersion(
    byte id
)

Set the ID of a mamaClientProfile object.

function getInterfaceVersion

byte getInterfaceVersion()

Get the ID of a mamaClientProfile object.

function setUserName

void setUserName(
    string userName
)

Set the user name.

function getUserName

string getUserName()

Get the user name.

Protected Functions Documentation

function DestroyNativePeer

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