contrib/ivshmem-client/ivshmem-client.h

13  * This file provides helper to implement an ivshmem client. It is used
15  * guest. QEMU also implements an ivshmem client similar to this one, they both
18  * A standalone ivshmem client based on this file is provided for debug/test
28  * Maximum number of notification vectors supported by the client
35  * Each time a client connects to an ivshmem server, it is advertised to
37  * client receives a notification, it creates a IvshmemClientPeer
41  * client in (IvshmemClient)->local.
57     const IvshmemClient *client,
62  * Structure describing an ivshmem client
64  * This structure stores all information related to our client: the name
66  * server, our own client information, and a pointer the notification
84  * Initialize an ivshmem client
86  * @client:         A pointer to an uninitialized IvshmemClient structure
96 int ivshmem_client_init(IvshmemClient *client, const char *unix_sock_path,
104  * messages sent by the server, giving the ID of the client and the file
107  * @client: The ivshmem client
111 int ivshmem_client_connect(IvshmemClient *client);
116  * @client: The ivshmem client
118 void ivshmem_client_close(IvshmemClient *client);
128  * @client: The ivshmem client
133 void ivshmem_client_get_fds(const IvshmemClient *client, fd_set *fds,
142  * @client: The ivshmem client
144  *          that file descriptors that are not related to our client are
150 int ivshmem_client_handle_fds(IvshmemClient *client, fd_set *fds, int maxfd);
155  * @client: The ivshmem client
161 int ivshmem_client_notify(const IvshmemClient *client,
167  * @client: The ivshmem client
173 int ivshmem_client_notify_all_vects(const IvshmemClient *client,
179  * @client: The ivshmem client
184 int ivshmem_client_notify_broadcast(const IvshmemClient *client);
192  * @client:  The ivshmem client
198 ivshmem_client_search_peer(IvshmemClient *client, int64_t peer_id);
201  * Dump information of this ivshmem client on stdout
203  * Dump the id and the vectors of the given ivshmem client and the list
206  * @client: The ivshmem client
208 void ivshmem_client_dump(const IvshmemClient *client);