6 * Data transfer interface opening
10 FILE_LICENCE ( GPL2_OR_LATER );
13 #include <ipxe/tables.h>
14 #include <ipxe/socket.h>
23 * Parameter list for open() is:
28 /** Location is a URI string
30 * Parameter list for open() is:
32 * const char *uri_string;
35 /** Location is a socket
37 * Parameter list for open() is:
40 * struct sockaddr *peer;
41 * struct sockaddr *local;
50 * This is the "scheme" portion of the URI, e.g. "http" or
56 * @v intf Object interface
58 * @ret rc Return status code
60 int ( * open ) ( struct interface *intf, struct uri *uri );
63 /** URI opener table */
64 #define URI_OPENERS __table ( struct uri_opener, "uri_openers" )
66 /** Register a URI opener */
67 #define __uri_opener __table_entry ( URI_OPENERS, 01 )
69 /** A socket opener */
70 struct socket_opener {
71 /** Communication semantics (e.g. SOCK_STREAM) */
73 /** Address family (e.g. AF_INET) */
77 * @v intf Object interface
78 * @v peer Peer socket address
79 * @v local Local socket address, or NULL
80 * @ret rc Return status code
82 int ( * open ) ( struct interface *intf, struct sockaddr *peer,
83 struct sockaddr *local );
86 /** Socket opener table */
87 #define SOCKET_OPENERS __table ( struct socket_opener, "socket_openers" )
89 /** Register a socket opener */
90 #define __socket_opener __table_entry ( SOCKET_OPENERS, 01 )
92 extern struct uri_opener * xfer_uri_opener ( const char *scheme );
93 extern int xfer_open_uri ( struct interface *intf, struct uri *uri );
94 extern int xfer_open_uri_string ( struct interface *intf,
95 const char *uri_string );
96 extern int xfer_open_named_socket ( struct interface *intf, int semantics,
97 struct sockaddr *peer, const char *name,
98 struct sockaddr *local );
99 extern int xfer_open_socket ( struct interface *intf, int semantics,
100 struct sockaddr *peer, struct sockaddr *local );
101 extern int xfer_vopen ( struct interface *intf, int type, va_list args );
102 extern int xfer_open ( struct interface *intf, int type, ... );
103 extern int xfer_vreopen ( struct interface *intf, int type,
106 #endif /* _IPXE_OPEN_H */