IPC Interface
[Event Discrimination Service]

Files
file	xdasd.h
	OpenXDAS xdasd internal protocol definitions header.
The xdasd wire request function codes.
The wire protocol defines various wire requests. The order and position of these request codes is important, as they must line up with the function addresses specified in the static handler table defined at the top of xdasd_net_dispatch.
#define	XDASD_REQ_EVENT   0x0000
#define	XDASD_REQ_FILTER   0x0001
The xdasd event handler wire request sub-function codes.
The order and position of these event request sub-function codes is also important, as they must line up with the function addresses specified in the static handler table defined at the top of xdasd_event_process.
#define	XDASD_EVT_SRQ_CHECK   0x0000
#define	XDASD_EVT_SRQ_SUBMIT   0x0001
#define	XDASD_EVT_SRQ_CHECK_AND_SUBMIT   0x0002
Defines
#define	MAX_XDAS_REC_SIZE   (64 * 1024)
	The maximum size in bytes of an XDAS record.
#define	MAX_XDAS_MSG_SIZE   (2 * MAX_XDAS_REC_SIZE)
	The maximum size in bytes of an XDAS wire protocol message.
#define	XDASD_RESERVED_PORT   7629
	The xdasd IANA-assigned reserved port.
#define	XDASD_RUNPATH   "/var/run/xdasd"
	The local ipc run path.

---

Detailed Description

The client initiates a wire request by sending messages containing the following request header to the server (all integer fields are in network or hi-lo byte order, unless otherwise stated):

   size        data
   ----        ----
   4           reqsz (including this size field)
   4           reqfn (request function code)
      (optional request-specific fields)
   reqsz - 8   xdasd request data

The server acknowledges by returing messages containing the following response header to the client:

   size        data
   ----        ----
   4           rspsz (including this size field)
   4           rspst (response status code)
   4           rspms (minor status - non-zero if rspst is XDAS_S_FAILURE)
      (optional request-specific fields)
   rspsz - 12  internal xdasd response data

Request and response data fields contain data formatted according to the request code documentation. Each type of request has its own data format beyond the standard request and response header fields documented above.

---

Define Documentation

#define MAX_XDAS_MSG_SIZE   (2 * MAX_XDAS_REC_SIZE)

The maximum size in bytes of an XDAS wire protocol message.

Definition at line 86 of file xdasd.h.

Referenced by xdasd_read_stream().

#define MAX_XDAS_REC_SIZE   (64 * 1024)

The maximum size in bytes of an XDAS record.

Definition at line 82 of file xdasd.h.

Referenced by xdas_calc_max_record_len().

#define XDASD_EVT_SRQ_CHECK   0x0000

Definition at line 124 of file xdasd.h.

Referenced by xdas_send_record().

#define XDASD_EVT_SRQ_CHECK_AND_SUBMIT   0x0002

Definition at line 126 of file xdasd.h.

#define XDASD_EVT_SRQ_SUBMIT   0x0001

Definition at line 125 of file xdasd.h.

Referenced by xdas_send_import_record(), and xdas_send_record().

#define XDASD_REQ_EVENT   0x0000

Definition at line 112 of file xdasd.h.

Referenced by xdas_send_import_record(), and xdas_send_record().

#define XDASD_REQ_FILTER   0x0001

Definition at line 113 of file xdasd.h.

#define XDASD_RESERVED_PORT   7629

The xdasd IANA-assigned reserved port.

This port is used for Win32 local IPC and for remote XDAS protocol connections. For local Unix/Linux connections, Unix domain sockets are used. Security is derived from file system path used for the socket.

Definition at line 94 of file xdasd.h.

Referenced by xdas_service_connect(), and xdasd_create_listen_socket().

#define XDASD_RUNPATH   "/var/run/xdasd"

The local ipc run path.

Definition at line 98 of file xdasd.h.

Referenced by xdas_get_ipcpath().