libevent
2.2.1
Event notification library
|
Go to the documentation of this file.
26 #ifndef EVENT2_UTIL_H_INCLUDED_
27 #define EVENT2_UTIL_H_INCLUDED_
35 #include <event2/visibility.h>
41 #include <event2/event-config.h>
42 #ifdef EVENT__HAVE_SYS_TIME_H
45 #ifdef EVENT__HAVE_STDINT_H
47 #elif defined(EVENT__HAVE_INTTYPES_H)
50 #ifdef EVENT__HAVE_SYS_TYPES_H
51 #include <sys/types.h>
53 #ifdef EVENT__HAVE_STDDEF_H
60 #ifdef EVENT__HAVE_NETDB_H
66 #ifdef EVENT__HAVE_GETADDRINFO
71 #ifdef EVENT__HAVE_ERRNO_H
74 #include <sys/socket.h>
80 #if defined(EVENT__SIZEOF_VOID__) && !defined(EVENT__SIZEOF_VOID_P)
81 #define EVENT__SIZEOF_VOID_P EVENT__SIZEOF_VOID__
113 #ifdef EVENT__HAVE_UINT64_T
114 #define ev_uint64_t uint64_t
115 #define ev_int64_t int64_t
116 #elif defined(_WIN32)
117 #define ev_uint64_t unsigned __int64
118 #define ev_int64_t signed __int64
119 #elif EVENT__SIZEOF_LONG_LONG == 8
120 #define ev_uint64_t unsigned long long
121 #define ev_int64_t long long
122 #elif EVENT__SIZEOF_LONG == 8
123 #define ev_uint64_t unsigned long
124 #define ev_int64_t long
125 #elif defined(EVENT_IN_DOXYGEN_)
126 #define ev_uint64_t ...
127 #define ev_int64_t ...
129 #error "No way to define ev_uint64_t"
132 #ifdef EVENT__HAVE_UINT32_T
133 #define ev_uint32_t uint32_t
134 #define ev_int32_t int32_t
135 #elif defined(_WIN32)
136 #define ev_uint32_t unsigned int
137 #define ev_int32_t signed int
138 #elif EVENT__SIZEOF_LONG == 4
139 #define ev_uint32_t unsigned long
140 #define ev_int32_t signed long
141 #elif EVENT__SIZEOF_INT == 4
142 #define ev_uint32_t unsigned int
143 #define ev_int32_t signed int
144 #elif defined(EVENT_IN_DOXYGEN_)
145 #define ev_uint32_t ...
146 #define ev_int32_t ...
148 #error "No way to define ev_uint32_t"
151 #ifdef EVENT__HAVE_UINT16_T
152 #define ev_uint16_t uint16_t
153 #define ev_int16_t int16_t
154 #elif defined(_WIN32)
155 #define ev_uint16_t unsigned short
156 #define ev_int16_t signed short
157 #elif EVENT__SIZEOF_INT == 2
158 #define ev_uint16_t unsigned int
159 #define ev_int16_t signed int
160 #elif EVENT__SIZEOF_SHORT == 2
161 #define ev_uint16_t unsigned short
162 #define ev_int16_t signed short
163 #elif defined(EVENT_IN_DOXYGEN_)
164 #define ev_uint16_t ...
165 #define ev_int16_t ...
167 #error "No way to define ev_uint16_t"
170 #ifdef EVENT__HAVE_UINT8_T
171 #define ev_uint8_t uint8_t
172 #define ev_int8_t int8_t
173 #elif defined(EVENT_IN_DOXYGEN_)
174 #define ev_uint8_t ...
175 #define ev_int8_t ...
177 #define ev_uint8_t unsigned char
178 #define ev_int8_t signed char
181 #ifdef EVENT__HAVE_UINTPTR_T
182 #define ev_uintptr_t uintptr_t
183 #define ev_intptr_t intptr_t
184 #elif EVENT__SIZEOF_VOID_P <= 4
185 #define ev_uintptr_t ev_uint32_t
186 #define ev_intptr_t ev_int32_t
187 #elif EVENT__SIZEOF_VOID_P <= 8
188 #define ev_uintptr_t ev_uint64_t
189 #define ev_intptr_t ev_int64_t
190 #elif defined(EVENT_IN_DOXYGEN_)
191 #define ev_uintptr_t ...
192 #define ev_intptr_t ...
194 #error "No way to define ev_uintptr_t"
197 #ifdef EVENT__ssize_t
198 #define ev_ssize_t EVENT__ssize_t
200 #define ev_ssize_t ssize_t
211 #define ev_off_t ev_int64_t
212 #elif EVENT__SIZEOF_OFF_T == 8
213 #define ev_off_t ev_int64_t
214 #elif EVENT__SIZEOF_OFF_T == 4
215 #define ev_off_t ev_int32_t
216 #elif defined(EVENT_IN_DOXYGEN_)
219 #define ev_off_t off_t
238 #ifndef EVENT__HAVE_STDINT_H
239 #define EV_UINT64_MAX ((((ev_uint64_t)0xffffffffUL) << 32) | 0xffffffffUL)
240 #define EV_INT64_MAX ((((ev_int64_t) 0x7fffffffL) << 32) | 0xffffffffL)
241 #define EV_INT64_MIN ((-EV_INT64_MAX) - 1)
242 #define EV_UINT32_MAX ((ev_uint32_t)0xffffffffUL)
243 #define EV_INT32_MAX ((ev_int32_t) 0x7fffffffL)
244 #define EV_INT32_MIN ((-EV_INT32_MAX) - 1)
245 #define EV_UINT16_MAX ((ev_uint16_t)0xffffUL)
246 #define EV_INT16_MAX ((ev_int16_t) 0x7fffL)
247 #define EV_INT16_MIN ((-EV_INT16_MAX) - 1)
248 #define EV_UINT8_MAX 255
249 #define EV_INT8_MAX 127
250 #define EV_INT8_MIN ((-EV_INT8_MAX) - 1)
252 #define EV_UINT64_MAX UINT64_MAX
253 #define EV_INT64_MAX INT64_MAX
254 #define EV_INT64_MIN INT64_MIN
255 #define EV_UINT32_MAX UINT32_MAX
256 #define EV_INT32_MAX INT32_MAX
257 #define EV_INT32_MIN INT32_MIN
258 #define EV_UINT16_MAX UINT16_MAX
259 #define EV_INT16_MIN INT16_MIN
260 #define EV_INT16_MAX INT16_MAX
261 #define EV_UINT8_MAX UINT8_MAX
262 #define EV_INT8_MAX INT8_MAX
263 #define EV_INT8_MIN INT8_MIN
273 #if EVENT__SIZEOF_SIZE_T == 8
274 #define EV_SIZE_MAX EV_UINT64_MAX
275 #define EV_SSIZE_MAX EV_INT64_MAX
276 #elif EVENT__SIZEOF_SIZE_T == 4
277 #define EV_SIZE_MAX EV_UINT32_MAX
278 #define EV_SSIZE_MAX EV_INT32_MAX
279 #elif defined(EVENT_IN_DOXYGEN_)
280 #define EV_SIZE_MAX ...
281 #define EV_SSIZE_MAX ...
283 #error "No way to define SIZE_MAX"
286 #define EV_SSIZE_MIN ((-EV_SSIZE_MAX) - 1)
290 #define ev_socklen_t int
291 #elif defined(EVENT__socklen_t)
292 #define ev_socklen_t EVENT__socklen_t
294 #define ev_socklen_t socklen_t
297 #ifdef EVENT__HAVE_STRUCT_SOCKADDR_STORAGE___SS_FAMILY
298 #if !defined(EVENT__HAVE_STRUCT_SOCKADDR_STORAGE_SS_FAMILY) \
299 && !defined(ss_family)
300 #define ss_family __ss_family
308 #define evutil_socket_t intptr_t
310 #define evutil_socket_t int
326 #ifdef EVENT_IN_DOXYGEN_
331 #define EV_MONOT_PRECISE 1
332 #define EV_MONOT_FALLBACK 2
340 EVENT2_EXPORT_SYMBOL
int
477 #define EVUTIL_CLOSESOCKET(s) evutil_closesocket(s)
507 #define EVUTIL_SOCKET_ERROR() WSAGetLastError()
509 #define EVUTIL_SET_SOCKET_ERROR(errcode) \
510 do { WSASetLastError(errcode); } while (0)
517 #define EVUTIL_INVALID_SOCKET INVALID_SOCKET
518 #elif defined(EVENT_IN_DOXYGEN_)
534 #define EVUTIL_SOCKET_ERROR() ...
536 #define EVUTIL_SET_SOCKET_ERROR(errcode) ...
538 #define evutil_socket_geterror(sock) ...
540 #define evutil_socket_error_to_string(errcode) ...
541 #define EVUTIL_INVALID_SOCKET -1
544 #define EVUTIL_SOCKET_ERROR() (errno)
545 #define EVUTIL_SET_SOCKET_ERROR(errcode) \
546 do { errno = (errcode); } while (0)
547 #define evutil_socket_geterror(sock) (errno)
548 #define evutil_socket_error_to_string(errcode) (strerror(errcode))
549 #define EVUTIL_INVALID_SOCKET -1
561 #ifdef EVENT__HAVE_TIMERADD
562 #define evutil_timeradd(tvp, uvp, vvp) timeradd((tvp), (uvp), (vvp))
563 #define evutil_timersub(tvp, uvp, vvp) timersub((tvp), (uvp), (vvp))
565 #define evutil_timeradd(tvp, uvp, vvp) \
567 (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec; \
568 (vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec; \
569 if ((vvp)->tv_usec >= 1000000) { \
571 (vvp)->tv_usec -= 1000000; \
574 #define evutil_timersub(tvp, uvp, vvp) \
576 (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec; \
577 (vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec; \
578 if ((vvp)->tv_usec < 0) { \
580 (vvp)->tv_usec += 1000000; \
585 #ifdef EVENT__HAVE_TIMERCLEAR
586 #define evutil_timerclear(tvp) timerclear(tvp)
588 #define evutil_timerclear(tvp) (tvp)->tv_sec = (tvp)->tv_usec = 0
594 #define evutil_timercmp(tvp, uvp, cmp) \
595 (((tvp)->tv_sec == (uvp)->tv_sec) ? \
596 ((tvp)->tv_usec cmp (uvp)->tv_usec) : \
597 ((tvp)->tv_sec cmp (uvp)->tv_sec))
599 #ifdef EVENT__HAVE_TIMERISSET
600 #define evutil_timerisset(tvp) timerisset(tvp)
602 #define evutil_timerisset(tvp) ((tvp)->tv_sec || (tvp)->tv_usec)
607 #define evutil_offsetof(type, field) offsetof(type, field)
609 #define evutil_offsetof(type, field) ((off_t)(&((type *)0)->field))
615 ev_int64_t
evutil_strtoll(
const char *s,
char **endptr,
int base);
618 #ifdef EVENT__HAVE_GETTIMEOFDAY
619 #define evutil_gettimeofday(tv, tz) gettimeofday((tv), (tz))
623 int evutil_gettimeofday(
struct timeval *tv,
struct timezone *tz);
632 __attribute__((format(printf, 3, 4)))
639 int evutil_vsnprintf(
char *buf,
size_t buflen,
const char *format, va_list ap)
641 __attribute__((format(printf, 3, 0)))
647 const char *
evutil_inet_ntop(
int af,
const void *src,
char *dst,
size_t len);
704 #ifdef EVENT__HAVE_STRUCT_ADDRINFO
705 #define evutil_addrinfo addrinfo
719 struct sockaddr *ai_addr;
730 #if defined(EAI_ADDRFAMILY) && defined(EVENT__HAVE_GETADDRINFO)
731 #define EVUTIL_EAI_ADDRFAMILY EAI_ADDRFAMILY
733 #define EVUTIL_EAI_ADDRFAMILY -901
735 #if defined(EAI_AGAIN) && defined(EVENT__HAVE_GETADDRINFO)
736 #define EVUTIL_EAI_AGAIN EAI_AGAIN
738 #define EVUTIL_EAI_AGAIN -902
740 #if defined(EAI_BADFLAGS) && defined(EVENT__HAVE_GETADDRINFO)
741 #define EVUTIL_EAI_BADFLAGS EAI_BADFLAGS
743 #define EVUTIL_EAI_BADFLAGS -903
745 #if defined(EAI_FAIL) && defined(EVENT__HAVE_GETADDRINFO)
746 #define EVUTIL_EAI_FAIL EAI_FAIL
748 #define EVUTIL_EAI_FAIL -904
750 #if defined(EAI_FAMILY) && defined(EVENT__HAVE_GETADDRINFO)
751 #define EVUTIL_EAI_FAMILY EAI_FAMILY
753 #define EVUTIL_EAI_FAMILY -905
755 #if defined(EAI_MEMORY) && defined(EVENT__HAVE_GETADDRINFO)
756 #define EVUTIL_EAI_MEMORY EAI_MEMORY
758 #define EVUTIL_EAI_MEMORY -906
763 #if defined(EAI_NODATA) && defined(EVENT__HAVE_GETADDRINFO) && (!defined(EAI_NONAME) || EAI_NODATA != EAI_NONAME)
764 #define EVUTIL_EAI_NODATA EAI_NODATA
766 #define EVUTIL_EAI_NODATA -907
768 #if defined(EAI_NONAME) && defined(EVENT__HAVE_GETADDRINFO)
769 #define EVUTIL_EAI_NONAME EAI_NONAME
771 #define EVUTIL_EAI_NONAME -908
773 #if defined(EAI_SERVICE) && defined(EVENT__HAVE_GETADDRINFO)
774 #define EVUTIL_EAI_SERVICE EAI_SERVICE
776 #define EVUTIL_EAI_SERVICE -909
778 #if defined(EAI_SOCKTYPE) && defined(EVENT__HAVE_GETADDRINFO)
779 #define EVUTIL_EAI_SOCKTYPE EAI_SOCKTYPE
781 #define EVUTIL_EAI_SOCKTYPE -910
783 #if defined(EAI_SYSTEM) && defined(EVENT__HAVE_GETADDRINFO)
784 #define EVUTIL_EAI_SYSTEM EAI_SYSTEM
786 #define EVUTIL_EAI_SYSTEM -911
789 #define EVUTIL_EAI_CANCEL -90001
791 #if defined(AI_PASSIVE) && defined(EVENT__HAVE_GETADDRINFO)
792 #define EVUTIL_AI_PASSIVE AI_PASSIVE
794 #define EVUTIL_AI_PASSIVE 0x1000
796 #if defined(AI_CANONNAME) && defined(EVENT__HAVE_GETADDRINFO)
797 #define EVUTIL_AI_CANONNAME AI_CANONNAME
799 #define EVUTIL_AI_CANONNAME 0x2000
801 #if defined(AI_NUMERICHOST) && defined(EVENT__HAVE_GETADDRINFO)
802 #define EVUTIL_AI_NUMERICHOST AI_NUMERICHOST
804 #define EVUTIL_AI_NUMERICHOST 0x4000
806 #if defined(AI_NUMERICSERV) && defined(EVENT__HAVE_GETADDRINFO)
807 #define EVUTIL_AI_NUMERICSERV AI_NUMERICSERV
809 #define EVUTIL_AI_NUMERICSERV 0x8000
811 #if defined(AI_V4MAPPED) && defined(EVENT__HAVE_GETADDRINFO)
812 #define EVUTIL_AI_V4MAPPED AI_V4MAPPED
814 #define EVUTIL_AI_V4MAPPED 0x10000
816 #if defined(AI_ALL) && defined(EVENT__HAVE_GETADDRINFO)
817 #define EVUTIL_AI_ALL AI_ALL
819 #define EVUTIL_AI_ALL 0x20000
821 #if defined(AI_ADDRCONFIG) && defined(EVENT__HAVE_GETADDRINFO)
822 #define EVUTIL_AI_ADDRCONFIG AI_ADDRCONFIG
824 #define EVUTIL_AI_ADDRCONFIG 0x40000
849 const char *evutil_gai_strerror(
int err);
Structure to hold information about a monotonic timer.
Definition: util.h:325
EVENT2_EXPORT_SYMBOL int evutil_inet_pton(int af, const char *src, void *dst)
Replacement for inet_pton for platforms which lack it.
EVENT2_EXPORT_SYMBOL int evutil_date_rfc1123(char *date, const size_t datelen, const struct tm *tm)
Format a date string using RFC 1123 format (used in HTTP).
EVENT2_EXPORT_SYMBOL int evutil_gettime_monotonic(struct evutil_monotonic_timer *timer, struct timeval *tp)
Query the current monotonic time from a struct evutil_monotonic_timer previously configured with evut...
EVENT2_EXPORT_SYMBOL int evutil_set_tcp_keepalive(evutil_socket_t sock, int on, int timeout)
Do platform-specific operations to set/unset TCP keep-alive options TCP_KEEPIDLE, TCP_KEEPINTVL and T...
EVENT2_EXPORT_SYMBOL int evutil_ascii_strcasecmp(const char *str1, const char *str2)
As strcasecmp, but always compares the characters in locale-independent ASCII.
EVENT2_EXPORT_SYMBOL int evutil_make_listen_socket_ipv6only(evutil_socket_t sock)
Set ipv6 only bind socket option to make listener work only in ipv6 sockets.
EVENT2_EXPORT_SYMBOL int evutil_getaddrinfo(const char *nodename, const char *servname, const struct evutil_addrinfo *hints_in, struct evutil_addrinfo **res)
This function clones getaddrinfo for systems that don't have it.
EVENT2_EXPORT_SYMBOL int evutil_ascii_strncasecmp(const char *str1, const char *str2, size_t n)
As strncasecmp, but always compares the characters in locale-independent ASCII.
EVENT2_EXPORT_SYMBOL int evutil_make_socket_nonblocking(evutil_socket_t sock)
Do platform-specific operations as needed to make a socket nonblocking.
EVENT2_EXPORT_SYMBOL int evutil_secure_rng_init(void)
Seed the secure random number generator if needed, and return 0 on success or -1 on failure.
EVENT2_EXPORT_SYMBOL int evutil_parse_sockaddr_port(const char *str, struct sockaddr *out, int *outlen)
Parse an IPv4 or IPv6 address, with optional port, from a string.
EVENT2_EXPORT_SYMBOL int evutil_secure_rng_set_urandom_device_file(char *fname)
Set a filename to use in place of /dev/urandom for seeding the secure PRNG.
#define evutil_socket_error_to_string(errcode)
Convert a socket error to a string.
Definition: util.h:540
const EVENT2_EXPORT_SYMBOL char * evutil_inet_ntop(int af, const void *src, char *dst, size_t len)
Replacement for inet_ntop for platforms which lack it.
#define evutil_socket_geterror(sock)
Return the most recent socket error to occur on sock.
Definition: util.h:538
EVENT2_EXPORT_SYMBOL int evutil_snprintf(char *buf, size_t buflen, const char *format,...)
Replacement for snprintf to get consistent behavior on platforms for which the return value of snprin...
EVENT2_EXPORT_SYMBOL int evutil_make_listen_socket_not_ipv6only(evutil_socket_t sock)
Set ipv6 only bind socket option to make listener work in both ipv4 and ipv6 sockets.
EVENT2_EXPORT_SYMBOL int evutil_make_socket_closeonexec(evutil_socket_t sock)
Do platform-specific operations as needed to close a socket upon a successful execution of one of the...
EVENT2_EXPORT_SYMBOL int evutil_configure_monotonic_time(struct evutil_monotonic_timer *timer, int flags)
Set up a struct evutil_monotonic_timer; flags can include EV_MONOT_PRECISE and EV_MONOT_FALLBACK.
EVENT2_EXPORT_SYMBOL int evutil_socketpair(int domain, int type, int protocol, evutil_socket_t sv[2])
Create two new sockets that are connected to each other.
EVENT2_EXPORT_SYMBOL void evutil_freeaddrinfo(struct evutil_addrinfo *ai)
Release storage allocated by evutil_getaddrinfo or evdns_getaddrinfo.
EVENT2_EXPORT_SYMBOL struct evutil_monotonic_timer * evutil_monotonic_timer_new(void)
Allocate a new struct evutil_monotonic_timer for use with the evutil_configure_monotonic_time() and e...
EVENT2_EXPORT_SYMBOL int evutil_inet_pton_scope(int af, const char *src, void *dst, unsigned *indexp)
Variation of inet_pton that also parses IPv6 scopes.
EVENT2_EXPORT_SYMBOL ev_int64_t evutil_strtoll(const char *s, char **endptr, int base)
Parse a 64-bit value from a string.
EVENT2_EXPORT_SYMBOL int evutil_make_tcp_listen_socket_deferred(evutil_socket_t sock)
Do platform-specific operations, if possible, to make a tcp listener socket defer accept()s until the...
EVENT2_EXPORT_SYMBOL void evutil_secure_rng_add_bytes(const char *dat, size_t datlen)
Seed the random number generator with extra random bytes.
EVENT2_EXPORT_SYMBOL int evutil_sockaddr_cmp(const struct sockaddr *sa1, const struct sockaddr *sa2, int include_port)
Compare two sockaddrs; return 0 if they are equal, or less than 0 if sa1 preceeds sa2,...
EVENT2_EXPORT_SYMBOL int evutil_closesocket(evutil_socket_t sock)
Do the platform-specific call needed to close a socket returned from socket() or accept().
EVENT2_EXPORT_SYMBOL void evutil_monotonic_timer_free(struct evutil_monotonic_timer *timer)
Free a struct evutil_monotonic_timer that was allocated using evutil_monotonic_timer_new().
A definition of struct addrinfo for systems that lack it.
Definition: util.h:712
EVENT2_EXPORT_SYMBOL int evutil_make_listen_socket_reuseable_port(evutil_socket_t sock)
Do platform-specific operations to make a listener port reusable.
EVENT2_EXPORT_SYMBOL int evutil_make_listen_socket_reuseable(evutil_socket_t sock)
Do platform-specific operations to make a listener socket reusable.
EVENT2_EXPORT_SYMBOL int evutil_vsnprintf(char *buf, size_t buflen, const char *format, va_list ap)
Replacement for vsnprintf to get consistent behavior on platforms for which the return value of snpri...
EVENT2_EXPORT_SYMBOL void evutil_secure_rng_get_bytes(void *buf, size_t n)
Generate n bytes of secure pseudorandom data, and store them in buf.
#define evutil_socket_t
A type wide enough to hold the output of "socket()" or "accept()".
Definition: util.h:310