RingIOShm_Params_Tag Struct Reference

#include <RingIOShm.h>

Collaboration diagram for RingIOShm_Params_Tag:

[legend]

---

Detailed Description

Structure defining parameters for creating the RingIOShm instances.

Definition at line 238 of file RingIOShm.h.

Data Fields
RingIO_Params	commonParams
UInt16	ctrlRegionId
UInt16	dataRegionId
UInt16	attrRegionId
Ptr	ctrlSharedAddr
Ptr	dataSharedAddr
UInt32	dataSharedAddrSize
UInt32	footBufSize
Ptr	attrSharedAddr
UInt32	attrSharedAddrSize
GateMP_Handle	gateHandle
GateMP_LocalProtect	localProtect
GateMP_RemoteProtect	remoteProtect
UInt16	remoteProcId

---

Field Documentation

UInt16 RingIOShm_Params_Tag::attrRegionId

Shared region ID for RingIOShm attr buffer The index corresponding to the shared region from which shared memory will be allocated if attrSharedAddr is NULL. If a valid attrSharedAddr is provided, this field is ignored. Definition at line 256 of file RingIOShm.h.

Ptr RingIOShm_Params_Tag::attrSharedAddr

Shared Region Address for attr buffer If this field is NULL, memory equal to attrSharedAddrSize is allocated from heap associated with attrRegionId Definition at line 281 of file RingIOShm.h.

UInt32 RingIOShm_Params_Tag::attrSharedAddrSize

Attr Buffer size. Definition at line 286 of file RingIOShm.h.

RingIO_Params RingIOShm_Params_Tag::commonParams

Common create parameters .Same for all the implementations of FrameQ Definition at line 240 of file RingIOShm.h.

UInt16 RingIOShm_Params_Tag::ctrlRegionId

Shared region ID for RingIOShm control structures The index corresponding to the shared region from which shared memory will be allocated if ctrlSharedAddr is NULL. If a valid ctrlSharedAddr is provided, this field is ignored. Definition at line 242 of file RingIOShm.h.

Ptr RingIOShm_Params_Tag::ctrlSharedAddr

Shared region address for control structure. The shared address details for control, data and attribute buffers. a RingIOShm instance. If this field is NULL, memory equal to that required to allocate that RingIOShm instance control structure is allocated from heap associated with ctrlRegionId Definition at line 263 of file RingIOShm.h.

UInt16 RingIOShm_Params_Tag::dataRegionId

Shared region ID for RingIOShm data buffer The index corresponding to the shared region from which shared memory will be allocated if dataSharedAddr is NULL. If a valid dataSharedAddr is provided, this field is ignored. Definition at line 249 of file RingIOShm.h.

Ptr RingIOShm_Params_Tag::dataSharedAddr

Shared Region Address for data buffer If this field is NULL, memory equal to (dataSharedAddrSize + footBufSize) is allocated from heap associated with dataRegionId Definition at line 271 of file RingIOShm.h.

UInt32 RingIOShm_Params_Tag::dataSharedAddrSize

Data Buffer size. Definition at line 277 of file RingIOShm.h.

UInt32 RingIOShm_Params_Tag::footBufSize

Foot Buffer size. Definition at line 279 of file RingIOShm.h.

GateMP_Handle RingIOShm_Params_Tag::gateHandle

Gate for protection. If gateHandle is NULL: * If user has called RingIOShm_useModuleDefault then module wide default GateMP is used. * If RingIOShm_useModuleDefault is not set default gate will be used for all instances * else, If variables GateMP_LocalProtect localProtect and GateMP_RemoteProtect remoteProtect are set to correct values, a GateMP is created for the instance. Definition at line 288 of file RingIOShm.h.

GateMP_LocalProtect RingIOShm_Params_Tag::localProtect

Local protection level for the module instance. Definition at line 299 of file RingIOShm.h.

UInt16 RingIOShm_Params_Tag::remoteProcId

Remote processor id with which the RingIOShm communicates Definition at line 303 of file RingIOShm.h.

GateMP_RemoteProtect RingIOShm_Params_Tag::remoteProtect

Remote protection level for the module instance. Definition at line 301 of file RingIOShm.h.

---

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

• RingIOShm.h

---