PdcommGemState

Struct

GEM state of an endpoint, filled by pdcomm_gem_state() and embedded in ::PdcommGemResultInfo.

typedef struct PdcommGemState { ... } PdcommGemState

Declared in: #include <pdcomm_gem.h>

Members

communication

Field

Communication state, one of #PDCOMM_GEM_DISCONNECTED through #PDCOMM_GEM_COMMUNICATING.

uint32_t communication

Declared in: #include <pdcomm_gem.h>

control

Field

Equipment control state (#PDCOMM_GEM_EQUIPMENT_OFFLINE through #PDCOMM_GEM_ONLINE_REMOTE), or #PDCOMM_GEM_CONTROL_UNAVAILABLE for a host.

uint32_t control

Declared in: #include <pdcomm_gem.h>

endpoint_id

Field

Identifier of the TCP endpoint, as carried in ::PdcommTcpToken.

uint64_t endpoint_id

Declared in: #include <pdcomm_gem.h>

generation

Field

Current connection generation of the TCP endpoint.

uint64_t generation

Declared in: #include <pdcomm_gem.h>

online_mode

Field

Equipment online mode (#PDCOMM_GEM_LOCAL or #PDCOMM_GEM_REMOTE), or #PDCOMM_GEM_CONTROL_UNAVAILABLE for a host.

uint32_t online_mode

Declared in: #include <pdcomm_gem.h>

pending_count

Field

Number of occupied pending-request slots, at most 32.

size_t pending_count

Declared in: #include <pdcomm_gem.h>

Includes requests retired by a disconnect whose final #PDCOMM_GEM_FAILED result has not been handled yet.

pending_ids

Field

Number of identifiers held by pending requests, counted against max_pending_ids for a host.

size_t pending_ids

Declared in: #include <pdcomm_gem.h>

role

Field

Configured role: #PDCOMM_GEM_HOST or #PDCOMM_GEM_EQUIPMENT.

uint32_t role

Declared in: #include <pdcomm_gem.h>

struct_size

Field

Structure size in bytes.

size_t struct_size

Declared in: #include <pdcomm_gem.h>

Set it to sizeof(PdcommGemState) or larger before the call. On success the library stores the size of the layout it wrote.

variable_count

Field

Number of registered status variables; 0 for a host.

size_t variable_count

Declared in: #include <pdcomm_gem.h>