david/ipxe
Archived
1
0
This repository has been archived on 2020-12-06. You can view files and clone it, but cannot push or open issues or pull requests.
ipxe/src/include/gpxe/open.h
2007-07-30 03:00:15 +01:00

96 lines
2.2 KiB
C

#ifndef _GPXE_OPEN_H
#define _GPXE_OPEN_H
/** @file
*
* Data transfer interface opening
*
*/
#include <stdarg.h>
#include <gpxe/tables.h>
struct xfer_interface;
struct uri;
struct sockaddr;
/** Location types */
enum {
/** Location is a URI
*
* Parameter list for open() is:
*
* struct uri *uri;
*/
LOCATION_URI = 1,
/** Location is a URI string
*
* Parameter list for open() is:
*
* const char *uri_string;
*/
LOCATION_URI_STRING,
/** Location is a socket
*
* Parameter list for open() is:
*
* int semantics;
* struct sockaddr *peer;
* struct sockaddr *local;
*/
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
*/
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 semantics (e.g. SOCK_STREAM) */
int semantics;
/** Address family (e.g. AF_INET) */
int family;
/** Open socket
*
* @v xfer Data transfer interface
* @v peer Peer socket address
* @v local Local socket address, or NULL
* @ret rc Return status code
*/
int ( * open ) ( struct xfer_interface *xfer, struct sockaddr *peer,
struct sockaddr *local );
};
/** Register a socket opener */
#define __socket_opener __table ( struct socket_opener, socket_openers, 01 )
extern int xfer_open_uri ( struct xfer_interface *xfer, struct uri *uri );
extern int xfer_open_uri_string ( struct xfer_interface *xfer,
const char *uri_string );
extern int xfer_open_named_socket ( struct xfer_interface *xfer,
int semantics, struct sockaddr *peer,
const char *name, struct sockaddr *local );
extern int xfer_open_socket ( struct xfer_interface *xfer, int semantics,
struct sockaddr *peer, struct sockaddr *local );
extern int xfer_vopen ( struct xfer_interface *xfer, int type, va_list args );
extern int xfer_open ( struct xfer_interface *xfer, int type, ... );
#endif /* _GPXE_OPEN_H */