PhTransportRegEntry_t

Data structure that describes data to be transported

Synopsis:

typedef struct ph_transport_reg_entry {
    char *type;
    int unsigned packing;
    int unsigned size;
    int unsigned num_fixups;
    PhTransportFixupRec_t const *fixups;
    int unsigned const *endians;
    } PhTransportRegEntry_t;

Description:

The PhTransportRegEntry_t structure describes how data is to be packed for the Photon transport mechanism, taking into account endian-ness and references to memory outside of the data type.

This structure includes the following:

type

The name of the type being registered.

packing

The packing method to be used (Ph_PACK_RAW, Ph_PACK_STRING, or Ph_PACK_STRUCT).

size

The size, in bytes, of the data type.

num_fixups

The number of entries in the fixups arrays.

fixups

A list of instructions for dealing with references to data outside the type being defined. For more information, see “Fixup manifests,” below.

endians

A zero-terminated array of endian information for the members of the data type. All types or references to types correct the endian-ness of their members based on the endian array defined for the type. For more information, see “Endian information,” below.

Fixup manifests

The fixup manifests are:

Endian information

The classifications of endian-sensitive members are:

Classification:

Photon

See also:

PhFindTransportType(), PhFreeTransportType(), PhMallocUnpack(), PhPackEntry(), PhRegisterTransportType(), PhTransportType(), PhUnpack()

“Registering new transport types” in the Drag and Drop chapter of the Photon Programmer's Guide