check_type: fix incorrect documentation.
[ccan] / ccan / nfs / libnfs-private.h
1 #ifndef CCAN_NFS_LIBNFS_PRIVATE_H
2 #define CCAN_NFS_LIBNFS_PRIVATE_H
3 /*
4    Copyright (C) by Ronnie Sahlberg <ronniesahlberg@gmail.com> 2010
5    
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3 of the License, or
9    (at your option) any later version.
10    
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15    
16    You should have received a copy of the GNU General Public License
17    along with this program; if not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #include <rpc/auth.h>
21
22 struct rpc_context {
23         int fd;
24         int is_connected;
25
26         char *error_string;
27
28         rpc_cb connect_cb;
29         void *connect_data;
30
31         AUTH *auth;
32         unsigned long xid;
33
34        /* buffer used for encoding RPC PDU */
35        char *encodebuf;
36        int encodebuflen;
37
38        struct rpc_pdu *outqueue;
39        struct rpc_pdu *waitpdu;
40
41        int insize;
42        int inpos;
43        char *inbuf;
44 };
45
46 struct rpc_pdu {
47         struct rpc_pdu *prev, *next;
48
49         unsigned long xid;
50         XDR xdr;
51
52         int written;
53         struct rpc_data outdata;
54
55         rpc_cb cb;
56         void *private_data;
57
58         /* function to decode the xdr reply data and buffer to decode into */
59         xdrproc_t xdr_decode_fn;
60         caddr_t xdr_decode_buf;
61         int xdr_decode_bufsize;
62 };
63
64 struct rpc_pdu *rpc_allocate_pdu(struct rpc_context *rpc, int program, int version, int procedure, rpc_cb cb, void *private_data, xdrproc_t xdr_decode_fn, int xdr_bufsize);
65 void rpc_free_pdu(struct rpc_context *rpc, struct rpc_pdu *pdu);
66 int rpc_queue_pdu(struct rpc_context *rpc, struct rpc_pdu *pdu);
67 int rpc_get_pdu_size(char *buf);
68 int rpc_process_pdu(struct rpc_context *rpc, char *buf, int size);
69 void rpc_error_all_pdus(struct rpc_context *rpc, char *error);
70
71 #endif /* CCAN_NFS_LIBNFS_PRIVATE_H */