bird/lib/socket.h

82 lines
2.6 KiB
C
Raw Normal View History

/*
* BIRD Socket Interface
*
* (c) 1998--1999 Martin Mares <mj@ucw.cz>
*
* Can be freely distributed and used under the terms of the GNU GPL.
*/
#ifndef _BIRD_SOCKET_H_
#define _BIRD_SOCKET_H_
#include "lib/resource.h"
typedef struct birdsock {
resource r;
1998-05-24 23:00:48 +08:00
pool *pool; /* Pool for socket data */
int type; /* Socket type */
void *data; /* User data */
ip_addr saddr, daddr; /* IPA_NONE = unspecified */
unsigned sport, dport; /* 0 = unspecified (for IP: protocol type) */
int tos; /* TOS and priority, -1 = default */
int ttl; /* Time To Live, -1 = default */
1998-05-24 23:00:48 +08:00
struct iface *iface; /* Interface; specify this for broad/multicast sockets */
byte *rbuf, *rpos; /* NULL=allocate automatically */
unsigned rbsize;
1998-05-24 23:00:48 +08:00
int (*rx_hook)(struct birdsock *, int size); /* NULL=receiving turned off, returns 1 to clear rx buffer */
byte *tbuf, *tpos; /* NULL=allocate automatically */
byte *ttx; /* Internal */
unsigned tbsize;
void (*tx_hook)(struct birdsock *);
1998-05-24 23:00:48 +08:00
void (*err_hook)(struct birdsock *, int); /* errno or zero if EOF */
1998-05-24 23:00:48 +08:00
ip_addr faddr; /* For packet protocols: source of current packet */
unsigned fport;
int fd; /* System-dependent data */
node n;
int entered;
1998-05-24 23:00:48 +08:00
} sock;
sock *sk_new(pool *); /* Allocate new socket */
int sk_open(sock *); /* Open socket */
void sk_close(sock *); /* Safe close of socket even from socket hook */
1998-05-24 23:00:48 +08:00
int sk_send(sock *, unsigned len); /* Send data, <0=err, >0=ok, 0=sleep */
int sk_send_to(sock *, unsigned len, ip_addr to, unsigned port); /* sk_send to given destination */
void sk_dump_all(void);
1999-05-31 21:21:07 +08:00
static inline int
sk_send_buffer_empty(sock *sk)
{
return sk->tbuf == sk->tpos;
}
/*
1998-05-24 23:00:48 +08:00
* Socket types SA SP DA DP IF TTL SendTo (?=may, -=must not, *=must)
*/
1998-05-24 23:00:48 +08:00
#define SK_TCP_PASSIVE 0 /* ? * - - - ? - */
#define SK_TCP_ACTIVE 1 /* ? ? * * - ? - */
#define SK_TCP 2
#define SK_UDP 3 /* ? ? - - - ? ? */
#define SK_UDP_MC 4 /* ? ? * * * * - */
#define SK_IP 5 /* ? - - * - ? ? */
#define SK_IP_MC 6 /* ? - * * * * - */
#define SK_MAGIC 7 /* Internal use by sysdep code */
1999-10-29 20:09:29 +08:00
#define SK_UNIX_PASSIVE 8
#define SK_UNIX 9
#define SK_DELETED 10 /* Internal use by sk_close */
/*
* Multicast sockets are slightly different from the other ones:
* If you want to send packets only, just set the destination
* address to the corresponding multicast group and iface to
* the interface to be used. If you also want receiving, set
* source address to the same multicast group as well.
*/
#endif