00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025 #ifndef SU_WAIT_H
00026
00027 #define SU_WAIT_H
00028
00038
00039
00040
00041 #ifndef SU_H
00042 #include "sofia-sip/su.h"
00043 #endif
00044
00045 #ifndef SU_TIME_H
00046 #include "sofia-sip/su_time.h"
00047 #endif
00048
00049 #if SU_HAVE_POLL
00050 #include <sys/poll.h>
00051 #endif
00052
00053 SOFIA_BEGIN_DECLS
00054
00055
00056
00057
00058 #if SU_HAVE_KQUEUE
00059
00060 #define SU_WAIT_CMP(x, y) \
00061 (((x).ident - (y).ident) ? ((x).ident - (y).ident) : ((x).flags - (y).flags))
00062
00064 #define SU_WAIT_IN (EVFILT_READ)
00065
00066 #define SU_WAIT_OUT (EVFILT_WRITE)
00067
00068 #define SU_WAIT_CONNECT (EVFILT_WRITE)
00069
00070 #define SU_WAIT_ERR (EV_ERROR)
00071
00072 #define SU_WAIT_HUP (EV_EOF)
00073
00074 #define SU_WAIT_ACCEPT (EVFILT_READ)
00075
00077 #define SU_WAIT_FOREVER (-1)
00078
00079 #define SU_WAIT_TIMEOUT (-2)
00080
00082 #define SU_WAIT_INIT { INVALID_SOCKET, 0, 0, 0, 0, NULL }
00083
00085 #define SU_WAIT_MAX (0x7fffffff)
00086
00087 #elif SU_HAVE_POLL || DOCUMENTATION_ONLY
00088
00089 #define SU_WAIT_CMP(x, y) \
00090 (((x).fd - (y).fd) ? ((x).fd - (y).fd) : ((x).events - (y).events))
00091
00093 #define SU_WAIT_IN (POLLIN)
00094
00095 #define SU_WAIT_OUT (POLLOUT)
00096
00097 #define SU_WAIT_CONNECT (POLLOUT)
00098
00099 #define SU_WAIT_ERR (POLLERR)
00100
00101 #define SU_WAIT_HUP (POLLHUP)
00102
00103 #define SU_WAIT_ACCEPT (POLLIN)
00104
00106 #define SU_WAIT_FOREVER (-1)
00107
00108 #define SU_WAIT_TIMEOUT (-2)
00109
00111 #define SU_WAIT_INIT { INVALID_SOCKET, 0, 0 }
00112
00114 #define SU_WAIT_MAX (0x7fffffff)
00115
00116 #elif SU_HAVE_WINSOCK
00117
00118 #define SU_WAIT_CMP(x, y) ((intptr_t)(x) - (intptr_t)(y))
00119
00120 #define SU_WAIT_IN (FD_READ)
00121 #define SU_WAIT_OUT (FD_WRITE)
00122 #define SU_WAIT_CONNECT (FD_CONNECT)
00123 #define SU_WAIT_ERR (0)
00124 #define SU_WAIT_HUP (FD_CLOSE)
00125 #define SU_WAIT_ACCEPT (FD_ACCEPT)
00126
00127 #define SU_WAIT_FOREVER (WSA_INFINITE)
00128 #define SU_WAIT_TIMEOUT (WSA_WAIT_TIMEOUT)
00129
00130 #define SU_WAIT_INIT NULL
00131
00132 #define SU_WAIT_MAX (64)
00133
00134 #else
00135
00136
00137 #define POLLIN 0x001
00138 #define POLLPRI 0x002
00139 #define POLLOUT 0x004
00140
00141 #ifdef __USE_XOPEN
00142 #define POLLRDNORM 0x040
00143 #define POLLRDBAND 0x080
00144 #define POLLWRNORM 0x100
00145 #define POLLWRBAND 0x200
00146 #endif
00147
00148
00149 #define POLLERR 0x008
00150 #define POLLHUP 0x010
00151 #define POLLNVAL 0x020
00152
00153 #define SU_WAIT_CMP(x, y) \
00154 (((x).fd - (y).fd) ? ((x).fd - (y).fd) : ((x).events - (y).events))
00155
00156 #define SU_WAIT_IN POLLIN
00157 #define SU_WAIT_OUT POLLOUT
00158 #define SU_WAIT_CONNECT POLLOUT
00159 #define SU_WAIT_ERR POLLERR
00160 #define SU_WAIT_HUP POLLHUP
00161 #define SU_WAIT_ACCEPT POLLIN
00162 #define SU_WAIT_FOREVER (-1)
00163 #define SU_WAIT_TIMEOUT (-2)
00164
00165 #define SU_WAIT_INIT { INVALID_SOCKET, 0, 0 }
00166
00168 #define SU_WAIT_MAX (0x7fffffff)
00169
00170 #endif
00171
00172
00173
00174
00176 #if SU_HAVE_KQUEUE
00177 typedef struct kevent su_wait_t;
00178 #elif SU_HAVE_POLL
00179 typedef struct pollfd su_wait_t;
00180 #elif SU_HAVE_WINSOCK
00181 typedef HANDLE su_wait_t;
00182 #else
00183
00184 typedef struct pollfd su_wait_t;
00185 struct pollfd {
00186 su_socket_t fd;
00187 short events;
00188 short revents;
00189 };
00190
00191
00192
00193 typedef unsigned long int nfds_t;
00194
00195
00196
00197
00198
00199
00200 int poll (struct pollfd *__fds, nfds_t __nfds, int __timeout);
00201
00202 #endif
00203
00204
00205 typedef int su_success_t;
00206
00207
00208
00210 typedef struct su_root_s su_root_t;
00211
00212 #ifndef SU_ROOT_MAGIC_T
00213
00223 #define SU_ROOT_MAGIC_T void
00224 #endif
00225
00236 typedef SU_ROOT_MAGIC_T su_root_magic_t;
00237
00238 #ifndef SU_WAKEUP_ARG_T
00239
00249 #define SU_WAKEUP_ARG_T void
00250 #endif
00251
00261 typedef SU_WAKEUP_ARG_T su_wakeup_arg_t;
00262
00268 typedef int (*su_wakeup_f)(su_root_magic_t *,
00269 su_wait_t *,
00270 su_wakeup_arg_t *arg);
00271
00272 enum {
00273 su_pri_normal,
00274 su_pri_first,
00275 su_pri_realtime
00276 };
00277
00278 struct _GSource;
00279
00281 SOFIAPUBVAR int su_root_size_hint;
00282
00283
00284
00285
00286 #ifndef SU_PREPOLL_MAGIC_T
00287
00297 #define SU_PREPOLL_MAGIC_T void
00298 #endif
00299
00310 typedef SU_PREPOLL_MAGIC_T su_prepoll_magic_t;
00311
00312
00317 typedef void su_prepoll_f(su_prepoll_magic_t *, su_root_t *);
00318
00319
00320
00321
00322 #ifdef SU_TIMER_T
00323 #error SU_TIMER_T defined
00324 #endif
00325
00326 #ifndef SU_TIMER_ARG_T
00327
00330 #define SU_TIMER_ARG_T void
00331 #endif
00332
00334 typedef struct su_timer_s su_timer_t;
00335
00337 typedef SU_TIMER_ARG_T su_timer_arg_t;
00338
00340 typedef void (*su_timer_f)(su_root_magic_t *magic,
00341 su_timer_t *t,
00342 su_timer_arg_t *arg);
00343
00344
00345
00346
00347
00349 typedef struct su_port_s su_port_t;
00350
00351 typedef struct { su_port_t *sut_port; su_root_t *sut_root; } _su_task_t;
00352
00354 typedef _su_task_t su_task_r[1];
00355
00357 #define SU_TASK_R_INIT {{ NULL, NULL }}
00358
00359
00360 typedef _su_task_t const *_su_task_r;
00361
00362
00363
00364
00365 #ifndef SU_MSG_ARG_T
00366
00369 #define SU_MSG_ARG_T void
00370 #endif
00371
00373 typedef SU_MSG_ARG_T su_msg_arg_t;
00374
00376 typedef struct su_msg_s su_msg_t;
00377
00379 typedef su_msg_t *su_msg_r[1];
00380
00382 typedef su_msg_t * const su_msg_cr[1];
00383
00385 #define SU_MSG_R_INIT { NULL }
00386
00388 typedef void su_msg_function(su_root_magic_t *magic,
00389 su_msg_r msg,
00390 su_msg_arg_t *arg);
00391
00393 typedef su_msg_function *su_msg_f;
00394
00395
00396
00397
00398
00399 #ifndef SU_CLONE_T
00400 #define SU_CLONE_T struct su_clone_s
00401 #endif
00402
00404 typedef SU_CLONE_T *su_clone_r[1];
00405
00407 #define SU_CLONE_R_INIT {NULL}
00408
00410 typedef int (*su_root_init_f)(su_root_t *, su_root_magic_t *);
00411
00413 typedef void (*su_root_deinit_f)(su_root_t *, su_root_magic_t *);
00414
00415
00416
00417
00418
00419 SOFIAPUBFUN void su_wait_init(su_wait_t dst[1]);
00420 SOFIAPUBFUN int su_wait_create(su_wait_t *dst, su_socket_t s, int events);
00421 SOFIAPUBFUN int su_wait_destroy(su_wait_t *dst);
00422 SOFIAPUBFUN int su_wait(su_wait_t waits[], unsigned n, su_duration_t timeout);
00423 SOFIAPUBFUN int su_wait_events(su_wait_t *wait, su_socket_t s);
00424 SOFIAPUBFUN int su_wait_mask(su_wait_t *dst, su_socket_t s, int events);
00425
00426 #if !HAVE_WIN32 && (SU_HAVE_POLL || HAVE_SELECT)
00427 su_inline
00428 su_socket_t su_wait_socket(su_wait_t *wait)
00429 {
00430 #if SU_HAVE_KQUEUE
00431 return wait->ident;
00432 #else
00433 return wait->fd;
00434 #endif
00435 }
00436 #endif
00437
00438
00439 SOFIAPUBFUN su_root_t *su_root_create(su_root_magic_t *magic)
00440 __attribute__((__malloc__));
00441 SOFIAPUBFUN void su_root_destroy(su_root_t*);
00442 SOFIAPUBFUN char const *su_root_name(su_root_t *self);
00443 SOFIAPUBFUN int su_root_set_magic(su_root_t *self, su_root_magic_t *magic);
00444 SOFIAPUBFUN su_root_magic_t *su_root_magic(su_root_t *root);
00445 SOFIAPUBFUN int su_root_register(su_root_t*, su_wait_t *,
00446 su_wakeup_f, su_wakeup_arg_t *,
00447 int priority);
00448
00449 SOFIAPUBFUN int su_root_unregister(su_root_t*, su_wait_t *,
00450 su_wakeup_f, su_wakeup_arg_t*);
00451 SOFIAPUBFUN int su_root_deregister(su_root_t*, int);
00452 SOFIAPUBFUN int su_root_eventmask(su_root_t *,
00453 int index, int socket, int events);
00454 SOFIAPUBFUN su_duration_t su_root_step(su_root_t *root, su_duration_t timeout);
00455 SOFIAPUBFUN su_duration_t su_root_sleep(su_root_t *root, su_duration_t);
00456 SOFIAPUBFUN int su_root_multishot(su_root_t *root, int multishot);
00457 SOFIAPUBFUN void su_root_run(su_root_t *root);
00458 SOFIAPUBFUN void su_root_break(su_root_t *root);
00459 SOFIAPUBFUN _su_task_r su_root_task(su_root_t const *root);
00460 SOFIAPUBFUN _su_task_r su_root_parent(su_root_t const *root);
00461
00462 SOFIAPUBFUN int su_root_add_prepoll(su_root_t *root,
00463 su_prepoll_f *,
00464 su_prepoll_magic_t *);
00465 SOFIAPUBFUN int su_root_remove_prepoll(su_root_t *root);
00466
00467 SOFIAPUBFUN struct _GSource *su_root_gsource(su_root_t *self);
00468
00469 SOFIAPUBFUN int su_root_yield(su_root_t *root);
00470
00471 SOFIAPUBFUN int su_root_release(su_root_t *root);
00472 SOFIAPUBFUN int su_root_obtain(su_root_t *root);
00473 SOFIAPUBFUN int su_root_has_thread(su_root_t *root);
00474
00475
00476 SOFIAPUBFUN su_timer_t *su_timer_create(su_task_r const, su_duration_t msec)
00477 __attribute__((__malloc__));
00478 SOFIAPUBFUN void su_timer_destroy(su_timer_t *);
00479 SOFIAPUBFUN int su_timer_set(su_timer_t *, su_timer_f, su_timer_arg_t *);
00480 SOFIAPUBFUN int su_timer_set_interval(su_timer_t *t, su_timer_f,
00481 su_timer_arg_t *, su_duration_t);
00482 SOFIAPUBFUN int su_timer_set_at(su_timer_t *, su_timer_f,
00483 su_timer_arg_t *, su_time_t);
00484 SOFIAPUBFUN int su_timer_run(su_timer_t *, su_timer_f, su_timer_arg_t *);
00485 SOFIAPUBFUN int su_timer_set_for_ever(su_timer_t *, su_timer_f,
00486 su_timer_arg_t *);
00487 SOFIAPUBFUN int su_timer_reset(su_timer_t *);
00488
00489 SOFIAPUBFUN su_root_t *su_timer_root(su_timer_t const *);
00490
00491 SOFIAPUBFUN int su_timer_expire(su_timer_t ** const,
00492 su_duration_t *tout,
00493 su_time_t now);
00494
00495
00496
00498 SOFIAPUBVAR su_task_r const su_task_null;
00499
00500 SOFIAPUBFUN _su_task_r su_task_init(su_task_r task);
00501 SOFIAPUBFUN void su_task_deinit(su_task_r task);
00502
00503 SOFIAPUBFUN void su_task_copy(su_task_r dst, su_task_r const src);
00504 SOFIAPUBFUN void su_task_move(su_task_r dst, su_task_r src);
00505 SOFIAPUBFUN int su_task_cmp(su_task_r const, su_task_r const);
00506 SOFIAPUBFUN int su_task_is_running(su_task_r const);
00507
00508 SOFIAPUBFUN su_root_t *su_task_root(su_task_r const self);
00509 SOFIAPUBFUN su_timer_t **su_task_timers(su_task_r const self);
00510
00511 SOFIAPUBFUN int su_task_execute(su_task_r const task,
00512 int (*function)(void *), void *arg,
00513 int *return_value);
00514
00515
00516 SOFIAPUBFUN int su_msg_create(su_msg_r msg,
00517 su_task_r const to, su_task_r const from,
00518 su_msg_f wakeup, isize_t size);
00519 SOFIAPUBFUN int su_msg_report(su_msg_r msg, su_msg_f report);
00520 SOFIAPUBFUN int su_msg_reply(su_msg_r reply, su_msg_r const msg,
00521 su_msg_f wakeup, isize_t size);
00522 SOFIAPUBFUN void su_msg_destroy(su_msg_r msg);
00523 SOFIAPUBFUN void su_msg_save(su_msg_r msg, su_msg_r msg0);
00524 SOFIAPUBFUN void su_msg_remove_refs(su_msg_cr msg);
00525 SOFIAPUBFUN su_msg_arg_t *su_msg_data(su_msg_cr msg);
00526 SOFIAPUBFUN isize_t su_msg_size(su_msg_cr msg);
00527 SOFIAPUBFUN _su_task_r su_msg_from(su_msg_cr msg);
00528 SOFIAPUBFUN _su_task_r su_msg_to(su_msg_cr msg);
00529 SOFIAPUBFUN int su_msg_send(su_msg_r msg);
00530
00532 #if SU_HAVE_INLINE
00533 static SU_INLINE
00534 int su_msg_is_non_null(su_msg_cr msg)
00535 {
00536 return msg && *msg != NULL;
00537 }
00538 #else
00539 #define su_msg_is_non_null(msg) ((msg) && (*(msg)) != NULL)
00540 #endif
00541
00542
00543 SOFIAPUBFUN int su_root_threading(su_root_t *self, int enable);
00544 SOFIAPUBFUN int su_clone_start(su_root_t *root,
00545 su_clone_r,
00546 su_root_magic_t *magic,
00547 su_root_init_f,
00548 su_root_deinit_f);
00549 SOFIAPUBFUN _su_task_r su_clone_task(su_clone_r);
00550 SOFIAPUBFUN void su_clone_forget(su_clone_r);
00551 SOFIAPUBFUN void su_clone_stop(su_clone_r);
00552 SOFIAPUBFUN void su_clone_wait(su_root_t *root, su_clone_r clone);
00553
00554 SOFIAPUBFUN int su_clone_pause(su_clone_r);
00555 SOFIAPUBFUN int su_clone_resume(su_clone_r);
00556
00557
00558
00559
00560 typedef su_port_t *su_port_create_f(void);
00561 typedef int su_clone_start_f(su_root_t *parent,
00562 su_clone_r return_clone,
00563 su_root_magic_t *magic,
00564 su_root_init_f init,
00565 su_root_deinit_f deinit);
00566
00567 SOFIAPUBFUN void su_port_prefer(su_port_create_f *f, su_clone_start_f *);
00568
00569 SOFIAPUBFUN su_port_create_f su_default_port_create;
00570 SOFIAPUBFUN su_port_create_f su_epoll_port_create;
00571 SOFIAPUBFUN su_port_create_f su_poll_port_create;
00572 SOFIAPUBFUN su_port_create_f su_wsaevent_port_create;
00573 SOFIAPUBFUN su_port_create_f su_select_port_create;
00574 SOFIAPUBFUN su_port_create_f su_kqueue_port_create;
00575 SOFIAPUBFUN su_port_create_f su_devpoll_port_create;
00576
00577 SOFIAPUBFUN su_clone_start_f su_default_clone_start;
00578 SOFIAPUBFUN su_clone_start_f su_epoll_clone_start;
00579 SOFIAPUBFUN su_clone_start_f su_poll_clone_start;
00580 SOFIAPUBFUN su_clone_start_f su_wsaevent_clone_start;
00581 SOFIAPUBFUN su_clone_start_f su_select_clone_start;
00582 SOFIAPUBFUN su_clone_start_f su_kqueue_clone_start;
00583 SOFIAPUBFUN su_clone_start_f su_devpoll_clone_start;
00584
00585 SOFIA_END_DECLS
00586
00587 #endif