contrib/ivshmem-client/ivshmem-client.h

13  * This file provides helper to implement an ivshmem client. It is used
14  * on the host to ask QEMU to send an interrupt to an ivshmem PCI device in a
15  * guest. QEMU also implements an ivshmem client similar to this one, they both
16  * connect to an ivshmem server.
35  * Each time a client connects to an ivshmem server, it is advertised to
38  * structure to store the infos of this peer.
40  * This structure is also used to store the information of our own
64  * This structure stores all information related to our client: the name
70     char unix_sock_path[PATH_MAX];      /**< path to unix sock */
80     bool verbose;                       /**< true to enable debug */
86  * @client:         A pointer to an uninitialized IvshmemClient structure
87  * @unix_sock_path: The pointer to the unix socket file name
88  * @notif_cb:       If not NULL, the pointer to the function to be called when
90  * @notif_arg:      Opaque pointer given as-is to the notification callback
92  * @verbose:        True to enable debug
101  * Connect to the server
103  * Connect to the server unix socket, and read the first initial
114  * Close connection to the server and free all peer structures
121  * Fill a fd_set with file descriptors to be monitored
125  * function will not initialize the fd_set, it is up to the caller
126  * to do this.
129  * @fds:    The fd_set to be updated
130  * @maxfd:  Must be set to the max file descriptor + 1 in fd_set. This value is
143  * @fds:    The fd_set containing the file descriptors to be checked. Note
144  *          that file descriptors that are not related to our client are
153  * Send a notification to a vector of a peer
156  * @peer:   The peer to be notified
165  * Send a notification to all vectors of a peer
168  * @peer:   The peer to be notified
177  * Broadcast a notification to all vectors of all peers