RingIOShm_Params_Tag Struct Reference

Structure defining parameters for creating the RingIOShm instances. More...

#include <RingIOShm.h>

Collaboration diagram for RingIOShm_Params_Tag:

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

---

Detailed Description

Structure defining parameters for creating the RingIOShm instances.

---

Field Documentation

RingIO_Params RingIOShm_Params_Tag::commonParams

Common create parameters .Same for all the implementations of FrameQ

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. Currently only id 0 is supported.

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. Currently only id 0 is supported.

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. Currently only id 0 is supported.

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

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

UInt32 RingIOShm_Params_Tag::dataSharedAddrSize

Data Buffer size.

UInt32 RingIOShm_Params_Tag::footBufSize

Foot Buffer size.

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

UInt32 RingIOShm_Params_Tag::attrSharedAddrSize

Attr Buffer size.

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.

GateMP_LocalProtect RingIOShm_Params_Tag::localProtect

Local protection level for the module instance.

GateMP_RemoteProtect RingIOShm_Params_Tag::remoteProtect

Remote protection level for the module instance.

UInt16 RingIOShm_Params_Tag::remoteProcId

Remote processor id with which the RingIOShm communicates

---

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

• RingIOShm.h