Private methods
This page documents the internal methods for XPA.jl
developers. Since these are not part of the public API, the page is hidden from the site navigation.
The functions documented here are internal to XPA.jl
and should not be considered as being part of the stable/public API.
Types
XPA.SendBuffer
— TypeXPA.SendBuffer
An instance of the XPA.SendBuffer
structure is provided to send callbacks to record the addresses where to store the address and size of the data associated to the answer of an XPA.get
request. A send callback shall use XPA.store!
to set the buffer contents.
See also
XPA.ReceiveBuffer
— TypeAn instance of the XPA.ReceiveBuffer
structure is provided to receive callbacks to record the address and the size of the data sent by an XPA.set
request. Methods pointer(buf)
and sizeof(buf)
can be used to query the address and the number of bytes of the buffer buf
.
See also
XPA.get
, XPA.Server
, and XPA.ReceiveCallback
.
XPA.NullBuffer
— TypeXPA.NullBuffer
singleton type representing an empty buffer when sending data to a server. Its length is 0
byte and its address is Ptr{Cvoid}(0)
.
XPA.TupleOf
— TypeXPA.TupleOf{T}
represents a tuple of any number of elements of type T
, it is an alias for Tuple{Vararg{T}}
XPA.CDefs
module
XPA.CDefs
— ModuleModule XPA.CDefs
provides Julia equivalents to constants and structures defined in C header xpa.h
. These private definitions are put in a sub-module to make them not directly accessible.
XPA.CDefs.SelOn
— Typeabstract type SelOn
Wrapper around XPA's SelOn
type:
typedef void (*SelOn)(void *client_data);
XPA.CDefs.SelOff
— Typeabstract type SelOff
Wrapper around XPA's SelOff
type:
typedef void (*SelOff)(void *client_data);
XPA.CDefs.SelAdd
— Typeabstract type SelAdd
Wrapper around XPA's SelAdd
type:
typedef void *(*SelAdd)(void *client_data, int fd);
XPA.CDefs.SelDel
— Typeabstract type SelDel
Wrapper around XPA's SelDel
type:
typedef void (*SelDel)(void *client_data);
XPA.CDefs.SendCb
— TypeSendCb
Wrapper around XPA's SendCb
type:
typedef int (*SendCb)(void *client_data, void *call_data, char *paramlist,
char **buf, size_t *len);
XPA.CDefs.ReceiveCb
— TypeReceiveCb
Wrapper around XPA's ReceiveCb
type:
typedef int (*ReceiveCb)(void *client_data, void *call_data,
char *paramlist, char *buf, size_t len);
XPA.CDefs.MyFree
— TypeMyFree
Wrapper around XPA's MyFree
type:
typedef void (*MyFree)(void *buf);
XPA.CDefs.InfoCb
— TypeInfoCb
Wrapper around XPA's InfoCb
type:
typedef int (*InfoCb)(void *client_data, void *call_data, char *paramlist);
XPA.CDefs.XPACommRec
— TypeXPACommRec
XPA communication structure for each connection.
XPA.CDefs.NSRec
— Typeabstract type NSRec
Opaque structure for struct nsrec
.
XPA.CDefs.ClipRec
— Typeabstract type ClipRec
Opaque structure for struct cliprec
.
XPA.CDefs.XPAInputRec
— Typeabstract type XPAInputRec
Opaque structure for struct xpainputrec
.
XPA.CDefs.XPAClientRec
— Typeabstract type XPAClientRec
Opaque structure for struct xpaclientrec
.
XPA.CDefs.XPACmdRec
— Typeabstract type XPACmdRec
Opaque structure for struct xpacmdrec
.