My Project
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Attributes | List of all members
otz_shared_mem_t Struct Reference

The otz_shared_memory_t structure is used to contain control information related to a block of shared memory that is mapped between the client and the service. More...

#include <otz_api.h>

Public Attributes

otz_state_t ui_state
 
uint32_t ui_length
 
uint32_t ui_flags
 
void * p_block
 
otz_session_tsession
 
int session_id
 
int operation_count
 
int s_errno
 
struct list head_ref
 

Detailed Description

The otz_shared_memory_t structure is used to contain control information related to a block of shared memory that is mapped between the client and the service.

Member Data Documentation

struct list otz_shared_mem_t::head_ref

List head used by Session

int otz_shared_mem_t::operation_count

Operation count

void* otz_shared_mem_t::p_block

The pointer to the block of shared memory.

int otz_shared_mem_t::s_errno

Service error number

otz_session_t* otz_shared_mem_t::session

Session context

int otz_shared_mem_t::session_id

Session identifier

uint32_t otz_shared_mem_t::ui_flags

The sharing flags of the shared memory block, indicating direction of data sharing.
Note that these access flags cannot usually be enforced by the hardware. If a client or a service ignores the flags specified for a shared memory block, or a corresponding memory reference, UNDEFINED behavior results.
Exactly one of the following flags must be specified:
OTZ_MEM_SERVICE_RO: The service can only read from the memory block.
OTZ_MEM_SERVICE_WO: The service can only write to the memory block.
OTZ_MEM_SERVICE_RW: The service can both read from and write to the memory block.

uint32_t otz_shared_mem_t::ui_length

The length of the shared memory block in bytes. Should not be zero

otz_state_t otz_shared_mem_t::ui_state

he state of this structure. For shared memory only the following states are used:
OTZ_STATE_INVALID: Shared memory block is not valid, but in a known state which can be freed.
OTZ_STATE_OPEN: Shared memory block is valid and references to it can be encoded in structured messages.
OTZ_STATE_UNDEFINED: Pseudo state covering all other behavior. A structure in this state must not be used unless explicitly specified, otherwise UNDEFINED behavior may occur


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