AAO DRAMA C++ Interface (Old style)
DRAMA C++, Depreciated, don't use for new code
Public Types | Public Member Functions | List of all members
DcppShared Class Reference

This is used to create and represent a shared memory segment. More...

#include <dcpp.h>

Public Types

enum  SharedType {
  Create = DITS_SHARE_CREATE , Gblsec = DITS_SHARE_GBLSEC , Global = DITS_SHARE_GLOBAL , ShMem = DITS_SHARE_SHMEM ,
  MMap = DITS_SHARE_MMAP
}
 This enum gives the various shared memory types. More...
 

Public Member Functions

 DcppShared (const SdsId &Template, StatusType *const status, const SharedType Type=Create, const int CreateIt=true, const char *const Name="", const int Key=0, void *const Address=0)
 Shared memory segment constructor - for an SDS structure.
 
 DcppShared (DitsSharedMemInfoType *Info, void *Address=0, SdsIdType ID=0, bool Free=false)
 Shared memory segment constructor - using existing segment.
 
 DcppShared (long Size, StatusType *const status, const SharedType Type=Create, const int CreateIt=true, const char *const Name="", const int Key=0, void *const Address=0)
 Basic Shared memory segment constructor.
 
virtual ~DcppShared ()
 Destructor - free shared memory and SDS ID.
 
void GetAddress (const void **Address, StatusType *status) const
 Return the shared memory address - const version.
 
void GetAddress (void **Address, StatusType *status)
 Return the shared memory address - non-const version.
 
void GetInfo (const DitsSharedMemInfoType **const Info, StatusType *const status) const
 Get share memory details - const version.
 
void GetInfo (DitsSharedMemInfoType **const Info, StatusType *const status)
 Get share memory details - non-const version.
 
SdsIdGetSds ()
 Return Sds structure id.
 
const SdsIdGetSds () const
 Return Sds structure id - const version.
 

Detailed Description

This is used to create and represent a shared memory segment.

When sending bulk data DRAMA messages, it is necessary to describe the bulk data shared memory segment. This type does this.


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