summaryrefslogtreecommitdiffstats
path: root/src/include/gpxe/open.h
blob: 8839dc28ab7cd2b4dab75f9ee8e11bda28d1a2e5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
#ifndef _GPXE_OPEN_H
#define _GPXE_OPEN_H

/** @file
 *
 * Data transfer interface opening
 *
 */

#include <gpxe/tables.h>

struct xfer_interface;
struct uri;
struct sockaddr;

/** Location types */
enum {
	/** Location is a URI string
	 *
	 * Parameter list for open() is:
	 *
	 * const char *uri_string;
	 */
	LOCATION_URI = 1,
	/** Location is a socket
	 *
	 * Parameter list for open() is:
	 *
	 * 
	 */
	LOCATION_SOCKET,
};

/** A URI opener */
struct uri_opener {
	/** URI protocol name
	 *
	 * This is the "scheme" portion of the URI, e.g. "http" or
	 * "file".
	 */
	const char *scheme;
	/** Open URI
	 *
	 * @v xfer		Data-transfer interface
	 * @v uri		URI
	 * @ret rc		Return status code
	 *
	 * This method takes ownership of the URI structure, and is
	 * responsible for eventually calling free_uri().
	 */
	int ( * open ) ( struct xfer_interface *xfer, struct uri *uri );
};

/** Register a URI opener */
#define __uri_opener __table ( struct uri_opener, uri_openers, 01 )

/** A socket opener */
struct socket_opener {
	/** Communication domain (e.g. PF_INET) */
	int domain;
	/** Communication semantics (e.g. SOCK_STREAM) */
	int type;
	/** Open socket
	 *
	 * @v xfer		Data-transfer interface
	 * @v sa		Socket address
	 * @ret rc		Return status code
	 */
	int ( * open ) ( struct xfer_interface *xfer, struct sockaddr *sa );
};

/** Register a socket opener */
#define __socket_opener __table ( struct socket_opener, socket_openers, 01 )

extern int open_uri ( struct xfer_interface *xfer, const char *uri_string );
extern int open_socket ( struct xfer_interface *xfer,
			 int domain, int type, struct sockaddr *sa );
extern int vopen ( struct xfer_interface *xfer, int type, va_list args );
extern int open ( struct xfer_interface *xfer, int type, ... );

#endif /* _GPXE_OPEN_H */