doc.go RawHistoryFolder

1// Package zerobus is a small D-Bus client that does not allocate in steady
2// state. It speaks the D-Bus wire protocol over a Unix socket and decodes
3// messages in place, so strings and arrays point into the receive buffer and
4// stay valid only until the next read.
5//
6// # Clients and servers
7//
8// A Conn has one encoder and one receive buffer. A client may block in Call,
9// which sends a method call and waits for its reply, and may set Handle to see
10// the messages that arrive meanwhile.
11//
12// A server loop uses only Send and ReadMessage, never Call or Handle. It
13// answers a method call with NewReply or NewError, emits NewSignal or the
14// directed NewSignalTo, and sends its own requests with NewMethodCall, which
15// returns the serial. The reply comes back later through ReadMessage as a
16// message whose ReplySerial is that serial. Decode a message completely before
17// the next Send is built and the next read: both reuse the same buffers.
18//
19// # Polling
20//
21// A loop that also waits for other descriptors gets the socket from
22// SyscallConn and waits for it to be readable. ReadMessage reads all the bytes
23// available, so call it while Buffered reports true before waiting again.
24// After the descriptor turns readable, ReadMessage may still block for the
25// rest of a message that has only partly arrived.
26package zerobus