9p: consolidate transport structure
[linux-2.6.git] / include / net / 9p / transport.h
1 /*
2  * include/net/9p/transport.h
3  *
4  * Transport Definition
5  *
6  *  Copyright (C) 2005 by Latchesar Ionkov <lucho@ionkov.net>
7  *  Copyright (C) 2004-2008 by Eric Van Hensbergen <ericvh@gmail.com>
8  *
9  *  This program is free software; you can redistribute it and/or modify
10  *  it under the terms of the GNU General Public License version 2
11  *  as published by the Free Software Foundation.
12  *
13  *  This program is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *  GNU General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License
19  *  along with this program; if not, write to:
20  *  Free Software Foundation
21  *  51 Franklin Street, Fifth Floor
22  *  Boston, MA  02111-1301  USA
23  *
24  */
25
26 #ifndef NET_9P_TRANSPORT_H
27 #define NET_9P_TRANSPORT_H
28
29 /**
30  * struct p9_trans_module - transport module interface
31  * @list: used to maintain a list of currently available transports
32  * @name: the human-readable name of the transport
33  * @maxsize: transport provided maximum packet size
34  * @def: set if this transport should be considered the default
35  * @create: member function to create a new connection on this transport
36  * @close: member function to disconnect and close the transport
37  * @rpc: member function to issue a request to the transport
38  *
39  * This is the basic API for a transport module which is registered by the
40  * transport module with the 9P core network module and used by the client
41  * to instantiate a new connection on a transport.
42  *
43  * BUGS: the transport module list isn't protected.
44  */
45
46 struct p9_trans_module {
47         struct list_head list;
48         char *name;             /* name of transport */
49         int maxsize;            /* max message size of transport */
50         int def;                /* this transport should be default */
51         struct module *owner;
52         int (*create)(struct p9_client *, const char *, char *);
53         void (*close) (struct p9_client *);
54         int (*rpc) (struct p9_client *t, struct p9_fcall *tc,
55                                                         struct p9_fcall **rc);
56 };
57
58 void v9fs_register_trans(struct p9_trans_module *m);
59 void v9fs_unregister_trans(struct p9_trans_module *m);
60 struct p9_trans_module *v9fs_get_trans_by_name(const substring_t *name);
61 struct p9_trans_module *v9fs_get_default_trans(void);
62 void v9fs_put_trans(struct p9_trans_module *m);
63 #endif /* NET_9P_TRANSPORT_H */