xs_wire.h File Reference

Go to the source code of this file.

Data Structures
struct	xsd_errors
struct	xsd_sockmsg
struct	xenstore_domain_interface

Macros
#define	XS_DEBUG   XS_CONTROL
#define	XS_WRITE_NONE   "NONE"
#define	XS_WRITE_CREATE   "CREATE"
#define	XS_WRITE_CREATE_EXCL   "CREATE|EXCL"
#define	XENSTORE_RING_SIZE   1024
#define	MASK_XENSTORE_IDX(idx)   ((idx) & (XENSTORE_RING_SIZE-1))
#define	XENSTORE_PAYLOAD_MAX   4096
#define	XENSTORE_ABS_PATH_MAX   3072
#define	XENSTORE_REL_PATH_MAX   2048
#define	XENSTORE_SERVER_FEATURE_RECONNECTION   1
#define	XENSTORE_SERVER_FEATURE_ERROR   2
#define	XENSTORE_CONNECTED   0 /* the steady-state */
#define	XENSTORE_RECONNECT   1 /* reconnect in progress */
#define	XENSTORE_ERROR_NONE   0 /* No error */
#define	XENSTORE_ERROR_COMM   1 /* Communication problem */
#define	XENSTORE_ERROR_RINGIDX   2 /* Invalid ring index */
#define	XENSTORE_ERROR_PROTO   3 /* Protocol violation (payload too long) */

Typedefs
typedef uint32_t	XENSTORE_RING_IDX

Enumerations
enum	xsd_sockmsg_type {   XS_CONTROL, XS_DIRECTORY, XS_READ, XS_GET_PERMS,   XS_WATCH, XS_UNWATCH, XS_TRANSACTION_START, XS_TRANSACTION_END,   XS_INTRODUCE, XS_RELEASE, XS_GET_DOMAIN_PATH, XS_WRITE,   XS_MKDIR, XS_RM, XS_SET_PERMS, XS_WATCH_EVENT,   XS_ERROR, XS_IS_DOMAIN_INTRODUCED, XS_RESUME, XS_SET_TARGET,   XS_RESET_WATCHES = XS_SET_TARGET + 2, XS_DIRECTORY_PART, XS_TYPE_COUNT, XS_INVALID = 0xffff }
enum	xs_watch_type { XS_WATCH_PATH = 0, XS_WATCH_TOKEN }

Functions
	FILE_LICENCE (MIT)

Macro Definition Documentation

XS_DEBUG

#define XS_DEBUG   XS_CONTROL

Definition at line 17 of file xs_wire.h.

XS_WRITE_NONE

#define XS_WRITE_NONE   "NONE"

Definition at line 46 of file xs_wire.h.

XS_WRITE_CREATE

#define XS_WRITE_CREATE   "CREATE"

Definition at line 47 of file xs_wire.h.

XS_WRITE_CREATE_EXCL

#define XS_WRITE_CREATE_EXCL   "CREATE|EXCL"

Definition at line 48 of file xs_wire.h.

XENSTORE_RING_SIZE

#define XENSTORE_RING_SIZE   1024

Definition at line 104 of file xs_wire.h.

MASK_XENSTORE_IDX

#define MASK_XENSTORE_IDX

(

idx

)

((idx) & (XENSTORE_RING_SIZE-1))

Definition at line 106 of file xs_wire.h.

XENSTORE_PAYLOAD_MAX

#define XENSTORE_PAYLOAD_MAX   4096

Definition at line 118 of file xs_wire.h.

XENSTORE_ABS_PATH_MAX

#define XENSTORE_ABS_PATH_MAX   3072

Definition at line 121 of file xs_wire.h.

XENSTORE_REL_PATH_MAX

#define XENSTORE_REL_PATH_MAX   2048

Definition at line 122 of file xs_wire.h.

XENSTORE_SERVER_FEATURE_RECONNECTION

#define XENSTORE_SERVER_FEATURE_RECONNECTION   1

Definition at line 125 of file xs_wire.h.

XENSTORE_SERVER_FEATURE_ERROR

#define XENSTORE_SERVER_FEATURE_ERROR   2

Definition at line 127 of file xs_wire.h.

XENSTORE_CONNECTED

#define XENSTORE_CONNECTED   0 /* the steady-state */

Definition at line 130 of file xs_wire.h.

XENSTORE_RECONNECT

#define XENSTORE_RECONNECT   1 /* reconnect in progress */

Definition at line 131 of file xs_wire.h.

XENSTORE_ERROR_NONE

#define XENSTORE_ERROR_NONE   0 /* No error */

Definition at line 134 of file xs_wire.h.

XENSTORE_ERROR_COMM

#define XENSTORE_ERROR_COMM   1 /* Communication problem */

Definition at line 135 of file xs_wire.h.

XENSTORE_ERROR_RINGIDX

#define XENSTORE_ERROR_RINGIDX   2 /* Invalid ring index */

Definition at line 136 of file xs_wire.h.

XENSTORE_ERROR_PROTO

#define XENSTORE_ERROR_PROTO   3 /* Protocol violation (payload too long) */

Definition at line 137 of file xs_wire.h.

Typedef Documentation

XENSTORE_RING_IDX

typedef uint32_t XENSTORE_RING_IDX

Definition at line 105 of file xs_wire.h.

Enumeration Type Documentation

xsd_sockmsg_type

enum xsd_sockmsg_type

Enumerator
XS_CONTROL
XS_DIRECTORY
XS_READ
XS_GET_PERMS
XS_WATCH
XS_UNWATCH
XS_TRANSACTION_START
XS_TRANSACTION_END
XS_INTRODUCE
XS_RELEASE
XS_GET_DOMAIN_PATH
XS_WRITE
XS_MKDIR
XS_RM
XS_SET_PERMS
XS_WATCH_EVENT
XS_ERROR
XS_IS_DOMAIN_INTRODUCED
XS_RESUME
XS_SET_TARGET
XS_RESET_WATCHES
XS_DIRECTORY_PART
XS_TYPE_COUNT
XS_INVALID

Definition at line 14 of file xs_wire.h.

{
    XS_CONTROL,
#define XS_DEBUG XS_CONTROL
    XS_DIRECTORY,
    XS_READ,
    XS_GET_PERMS,
    XS_WATCH,
    XS_UNWATCH,
    XS_TRANSACTION_START,
    XS_TRANSACTION_END,
    XS_INTRODUCE,
    XS_RELEASE,
    XS_GET_DOMAIN_PATH,
    XS_WRITE,
    XS_MKDIR,
    XS_RM,
    XS_SET_PERMS,
    XS_WATCH_EVENT,
    XS_ERROR,
    XS_IS_DOMAIN_INTRODUCED,
    XS_RESUME,
    XS_SET_TARGET,
    /* XS_RESTRICT has been removed */
    XS_RESET_WATCHES = XS_SET_TARGET + 2,
    XS_DIRECTORY_PART,

    XS_TYPE_COUNT,      /* Number of valid types. */

    XS_INVALID = 0xffff /* Guaranteed to remain an invalid type */
};

xs_watch_type

enum xs_watch_type

Enumerator
XS_WATCH_PATH
XS_WATCH_TOKEN

Definition at line 94 of file xs_wire.h.

{
    XS_WATCH_PATH = 0,
    XS_WATCH_TOKEN
};

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

MIT

)