1 /*
2 * Copyright (C) 1997-2004, Michael Jennings
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to
6 * deal in the Software without restriction, including without limitation the
7 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
8 * sell copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies of the Software, its documentation and marketing & publicity
13 * materials, and acknowledgment shall be given in the documentation, materials
14 * and software packages that this Software was used.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
20 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22 */
23
24 #ifndef _LIBAST_SOCKET_H_
25 #define _LIBAST_SOCKET_H_
26
27 /* Cast an arbitrary object pointer to a socket. */
28 #define SPIF_SOCKET(o) (SPIF_CAST(socket) (o))
29 #define SPIF_SOCKET_SOCKFD(o) (SPIF_SOCKET(o)->fd)
30 #define SPIF_SOCKET_SOCKADDR(o) (SPIF_SOCKET(o)->addr)
31 #define SPIF_SOCKET_SOCKADDR_IP(o) (SPIF_CAST(ipsockaddr) (SPIF_SOCKET(o)->addr))
32
33 /* Check to see if a pointer references an socket. */
34 #define SPIF_OBJ_IS_SOCKET(o) (SPIF_OBJ_IS_TYPE(o, socket))
35
36 /* Used for testing the NULL-ness of sockets. */
37 #define SPIF_SOCKET_ISNULL(o) (SPIF_SOCKET(o) == SPIF_NULL_TYPE(socket))
38
39 /* Calls to the basic functions. */
40 #define SPIF_SOCKET_NEW() SPIF_CAST(socket) (SPIF_CLASS(SPIF_CLASS_VAR(socket)))->(noo)()
41 #define SPIF_SOCKET_INIT(o) SPIF_OBJ_INIT(o)
42 #define SPIF_SOCKET_DONE(o) SPIF_OBJ_DONE(o)
43 #define SPIF_SOCKET_DEL(o) SPIF_OBJ_DEL(o)
44 #define SPIF_SOCKET_SHOW(o, b, i) SPIF_OBJ_SHOW(o, b, i)
45 #define SPIF_SOCKET_COMP(o1, o2) SPIF_OBJ_COMP(o)
46 #define SPIF_SOCKET_DUP(o) SPIF_OBJ_DUP(o)
47 #define SPIF_SOCKET_TYPE(o) SPIF_OBJ_TYPE(o)
48
49 /* Socket flags */
50 #define SPIF_SOCKET_FLAGS_FAMILY_INET (1UL << 0)
51 #define SPIF_SOCKET_FLAGS_FAMILY_UNIX (1UL << 1)
52 #define SPIF_SOCKET_FLAGS_FAMILY (0x0f << 0)
53 #define SPIF_SOCKET_FLAGS_TYPE_STREAM (1UL << 4)
54 #define SPIF_SOCKET_FLAGS_TYPE_DGRAM (1UL << 5)
55 #define SPIF_SOCKET_FLAGS_TYPE_RAW (1UL << 6)
56 #define SPIF_SOCKET_FLAGS_TYPE (0x0f << 4)
57 #define SPIF_SOCKET_FLAGS_LISTEN (1UL << 8)
58 #define SPIF_SOCKET_FLAGS_OPEN (1UL << 9)
59 #define SPIF_SOCKET_FLAGS_CONNECTED (1UL << 10)
60 #define SPIF_SOCKET_FLAGS_HAVE_INPUT (1UL << 11)
61 #define SPIF_SOCKET_FLAGS_CAN_OUTPUT (1UL << 12)
62 #define SPIF_SOCKET_FLAGS_NBIO (1UL << 13)
63 #define SPIF_SOCKET_FLAGS_IOSTATE (0xff << 8)
64 #define SPIF_SOCKET_FLAGS(s) (SPIF_SOCKET(s)->flags)
65 #define SPIF_SOCKET_FLAGS_SET(s, b) do {SPIF_SOCKET_FLAGS(s) |= (b);} while (0)
66 #define SPIF_SOCKET_FLAGS_CLEAR(s, b) do {SPIF_SOCKET_FLAGS(s) &= ~(b);} while (0)
67 #define SPIF_SOCKET_FLAGS_IS_SET(s, b) (SPIF_SOCKET_FLAGS(s) & (b))
68
69 #include <libast/url.h>
70
SPIF_DECL_OBJ(socket)71 SPIF_DECL_OBJ(socket) {
72 SPIF_DECL_PARENT_TYPE(obj);
73 spif_sockfd_t fd;
74 spif_sockfamily_t fam;
75 spif_socktype_t type;
76 spif_sockproto_t proto;
77 spif_sockaddr_t addr;
78 spif_sockaddr_len_t len;
79 spif_uint32_t flags;
80 spif_url_t local_url, remote_url;
81 };
82
83 extern spif_class_t SPIF_CLASS_VAR(socket);
84 extern spif_socket_t spif_socket_new(void);
85 extern spif_socket_t spif_socket_new_from_urls(spif_url_t, spif_url_t);
86 extern spif_bool_t spif_socket_del(spif_socket_t);
87 extern spif_bool_t spif_socket_init(spif_socket_t);
88 extern spif_bool_t spif_socket_init_from_urls(spif_socket_t, spif_url_t, spif_url_t);
89 extern spif_bool_t spif_socket_done(spif_socket_t);
90 extern spif_str_t spif_socket_show(spif_socket_t, spif_charptr_t, spif_str_t, size_t);
91 extern spif_cmp_t spif_socket_comp(spif_socket_t, spif_socket_t);
92 extern spif_socket_t spif_socket_dup(spif_socket_t);
93 extern spif_classname_t spif_socket_type(spif_socket_t);
94 extern spif_bool_t spif_socket_open(spif_socket_t);
95 extern spif_bool_t spif_socket_close(spif_socket_t);
96 extern spif_bool_t spif_socket_check_io(spif_socket_t);
97 extern spif_socket_t spif_socket_accept(spif_socket_t);
98 extern spif_bool_t spif_socket_send(spif_socket_t, spif_str_t);
99 extern spif_str_t spif_socket_recv(spif_socket_t);
100 extern spif_bool_t spif_socket_set_nbio(spif_socket_t);
101 extern spif_bool_t spif_socket_clear_nbio(spif_socket_t);
102
103 #endif /* _LIBAST_SOCKET_H_ */
104