25#ifndef TPORT_INTERNAL_H
27#define TPORT_INTERNAL_H
53#include "sofia-sip/stun.h"
54#include "sofia-sip/stun_tag.h"
62#define SU_LOG tport_log
66#if !defined(MSG_NOSIGNAL) || defined(__CYGWIN__) || defined(SYMBIAN)
68#define MSG_NOSIGNAL (0)
71#if (_WIN32_WINNT >= 0x0600)
73#define HAVE_MSG_TRUNC 1
82#define NONE ((void *)(intptr_t)-1)
87typedef struct tport_master tport_master_t;
88typedef struct tport_pending_s tport_pending_t;
89typedef struct tport_primary tport_primary_t;
90typedef struct tport_vtable tport_vtable_t;
92struct sigcomp_state_handler;
93struct sigcomp_algorithm;
96struct sigcomp_compartment;
98typedef long unsigned LU;
104 unsigned tpp_timeout;
105 unsigned tpp_keepalive;
106 unsigned tpp_pingpong;
108 unsigned tpp_sigcomp_lifetime;
109 unsigned tpp_thrpsize;
111 unsigned tpp_thrprqsize;
117 unsigned tpp_conn_orient:1;
118 unsigned tpp_sdwn_error:1;
119 unsigned tpp_stun_server:1;
120 unsigned tpp_pong2ping:1;
137 unsigned tp_accepted:1;
138 unsigned tp_conn_orient:1;
139 unsigned tp_has_connection:1;
140 unsigned tp_reusable:1;
141 unsigned tp_closed : 1;
148 unsigned tp_recv_close:2;
150 unsigned tp_send_close:2;
151 unsigned tp_has_keepalive:1;
152 unsigned tp_has_stun_server:1;
154 unsigned tp_is_connected:1;
155 unsigned tp_verified:1;
156 unsigned tp_error_reported:1;
161 tport_t *tp_left, *tp_right, *tp_dad;
163 tport_master_t *tp_master;
164 tport_primary_t *tp_pri;
166 tport_params_t *tp_params;
181 su_strlst_t *tp_subjects;
189#define tp_protoname tp_name->tpn_proto
190#define tp_canon tp_name->tpn_canon
191#define tp_host tp_name->tpn_host
192#define tp_port tp_name->tpn_port
193#define tp_ident tp_name->tpn_ident
200 su_sockaddr_t tp_addr[1];
201#define tp_addrlen tp_addrinfo->ai_addrlen
206 msg_t const *tp_rlogged;
208 unsigned short tp_ping;
212 unsigned short tp_reported;
215 tport_pending_t *tp_pending;
216 tport_pending_t *tp_released;
221 unsigned short tp_qhead;
229 msg_t const *tp_slogged;
234 tport_compressor_t *tp_comp;
239 uint64_t sent_msgs, sent_errors, sent_bytes, sent_on_line;
240 uint64_t recv_msgs, recv_errors, recv_bytes, recv_on_line;
245struct tport_primary {
246 tport_t pri_primary[1];
250#define pri_home pri_primary->tp_home
251#define pri_master pri_primary->tp_master
252#define pri_protoname pri_primary->tp_name->tpn_proto
261 tport_primary_t *pri_next;
266 unsigned pri_updating:1;
267 unsigned pri_natted:1;
268 unsigned pri_has_tls:1;
271 void *pri_stun_handle;
273 tport_params_t pri_params[1];
278 tport_t mr_master[1];
282#define mr_home mr_master->tp_home
285 int mr_stun_step_ready;
298 tport_primary_t *mr_primaries;
300 tport_params_t mr_params[1];
302 unsigned mr_boundserver:1;
303 unsigned mr_bindv6only:1;
307 struct tport_delivery {
311 tport_compressor_t *d_comp;
321 char *external_ip_address;
322#if HAVE_UPNP || HAVE_SOFIA_STUN
328 tport_master_t *tport;
333 su_sockaddr_t sockaddr;
342 char const *vtp_name;
346 int (*vtp_init_primary)(tport_primary_t *pri,
349 char const **return_culprit);
350 void (*vtp_deinit_primary)(tport_primary_t *pri);
351 int (*vtp_wakeup_pri)(tport_primary_t *pri,
int events);
352 tport_t *(*vtp_connect)(tport_primary_t *pri,
su_addrinfo_t *ai,
355 size_t vtp_secondary_size;
357 int (*vtp_init_secondary)(tport_t *,
int socket,
int accepted,
358 char const **return_reason);
359 void (*vtp_deinit_secondary)(tport_t *);
360 void (*vtp_shutdown)(tport_t *,
int how);
361 int (*vtp_set_events)(tport_t
const *self);
362 int (*vtp_wakeup)(tport_t *self,
int events);
363 int (*vtp_recv)(tport_t *self);
364 ssize_t (*vtp_send)(tport_t
const *self,
msg_t *msg,
367 int (*vtp_prepare)(tport_t *self,
msg_t *msg,
369 struct sigcomp_compartment *cc,
373 int (*vtp_stun_response)(tport_t
const *self,
374 void *msg,
size_t msglen,
375 void *addr, socklen_t addrlen);
376 int (*vtp_next_secondary_timer)(tport_t *self,
su_time_t *,
377 char const **return_why);
378 void (*vtp_secondary_timer)(tport_t *self,
su_time_t);
381int tport_register_type(tport_vtable_t
const *vtp);
384su_inline int tport_is_connection_oriented(tport_t
const *self)
386 return self->tp_conn_orient;
390su_inline int tport_has_connection(tport_t
const *self)
392 return self->tp_has_connection;
395void tport_has_been_updated(tport_t *tport);
397int tport_primary_compression(tport_primary_t *pri,
398 char const *compression,
403tport_t *tport_base_connect(tport_primary_t *pri,
408int tport_stream_init_primary(tport_primary_t *pri,
413 char const **return_reason);
415tport_t *tport_alloc_secondary(tport_primary_t *pri,
418 char const **return_reason);
420int tport_accept(tport_primary_t *pri,
int events);
421int tport_register_secondary(tport_t *self, su_wakeup_f wakeup,
int events);
422void tport_zap_secondary(tport_t *self);
424int tport_set_secondary_timer(tport_t *self);
425void tport_base_timer(tport_t *self,
su_time_t now);
427int tport_bind_socket(
int socket,
429 char const **return_culprit);
430void tport_close(tport_t *self);
431int tport_shutdown0(tport_t *self,
int how);
433int tport_has_queued(tport_t
const *self);
435int tport_error_event(tport_t *self);
436void tport_recv_event(tport_t *self);
437void tport_send_event(tport_t *self);
438void tport_hup_event(tport_t *self);
439int tport_setname(tport_t *,
char const *,
su_addrinfo_t const *,
char const *);
443ssize_t tport_recv_iovec(tport_t
const *self,
448msg_t *tport_msg_alloc(tport_t
const *self, usize_t size);
450int tport_prepare_and_send(tport_t *self,
msg_t *msg,
452 struct sigcomp_compartment *cc,
454int tport_send_msg(tport_t *self,
msg_t *msg,
456 struct sigcomp_compartment *cc);
458void tport_send_queue(tport_t *self);
460void tport_deliver(tport_t *self,
msg_t *msg,
msg_t *next,
461 tport_compressor_t *comp,
465int tport_recv_error_report(tport_t *self);
466void tport_error_report(tport_t *self,
int errcode,
467 su_sockaddr_t
const *addr);
469int tport_open_log(tport_master_t *mr,
tagi_t *tags);
470void tport_log_msg(tport_t *tp,
msg_t *msg,
char const *what,
472void tport_dump_iovec(tport_t
const *self,
msg_t *msg,
473 size_t n,
su_iovec_t const iov[],
size_t iovused,
474 char const *what,
char const *how);
476int tport_tcp_ping(tport_t *self,
su_time_t now);
477int tport_tcp_pong(tport_t *self);
479extern tport_vtable_t
const tport_udp_vtable;
480extern tport_vtable_t
const tport_udp_client_vtable;
482int tport_udp_init_primary(tport_primary_t *,
486 char const **return_culprit);
487void tport_udp_deinit_primary(tport_primary_t *);
488int tport_recv_dgram(tport_t *self);
489ssize_t tport_send_dgram(tport_t
const *self,
msg_t *msg,
491int tport_udp_error(tport_t
const *self, su_sockaddr_t name[1]);
493extern tport_vtable_t
const tport_tcp_vtable;
494extern tport_vtable_t
const tport_tcp_client_vtable;
496int tport_tcp_init_primary(tport_primary_t *,
499 char const **return_culprit);
500int tport_tcp_init_client(tport_primary_t *,
503 char const **return_culprit);
504int tport_tcp_init_secondary(tport_t *self,
int socket,
int accepted,
505 char const **return_reason);
506int tport_recv_stream(tport_t *self);
507ssize_t tport_send_stream(tport_t
const *self,
msg_t *msg,
510int tport_tcp_next_timer(tport_t *self,
su_time_t *,
char const **);
511void tport_tcp_timer(tport_t *self,
su_time_t);
513int tport_next_recv_timeout(tport_t *,
su_time_t *,
char const **);
514void tport_recv_timeout_timer(tport_t *self,
su_time_t now);
516int tport_next_keepalive(tport_t *self,
su_time_t *,
char const **);
517void tport_keepalive_timer(tport_t *self,
su_time_t now);
519extern tport_vtable_t
const tport_sctp_vtable;
520extern tport_vtable_t
const tport_sctp_client_vtable;
521extern tport_vtable_t
const tport_tls_vtable;
522extern tport_vtable_t
const tport_tls_client_vtable;
523extern tport_vtable_t
const tport_stun_vtable;
524extern tport_vtable_t
const tport_http_connect_vtable;
525extern tport_vtable_t
const tport_threadpool_vtable;
527typedef struct tport_descriptor_s {
528 char const *tpd_name;
529 tport_vtable_t *tpd_vtable;
531 int tpd_is_client_only;
534typedef int const *(tport_set_f)(tport_master_t *mr,
537 tport_descriptor_t **return_set,
538 int return_set_size);
542int tport_init_stun_server(tport_master_t *mr,
tagi_t const *tags);
543void tport_deinit_stun_server(tport_master_t *mr);
544int tport_recv_stun_dgram(tport_t
const *self,
msg_t **in_out_msg,
545 su_sockaddr_t *from, socklen_t fromlen);
547int tport_stun_server_add_socket(tport_t *tp);
548int tport_stun_server_remove_socket(tport_t *tp);
550void tport_recv_bytes(tport_t *self, ssize_t bytes, ssize_t on_line);
551void tport_recv_message(tport_t *self,
msg_t *msg,
int error);
553void tport_sent_bytes(tport_t *self, ssize_t bytes, ssize_t on_line);
554void tport_sent_message(tport_t *self,
msg_t *msg,
int error);
558extern tport_comp_vtable_t
const *tport_comp_vtable;
560char const *tport_canonize_comp(
char const *comp);
562int tport_init_compressor(tport_t *,
563 char const *comp_name,
565void tport_deinit_compressor(tport_t *);
567struct sigcomp_compartment *
568tport_sigcomp_assign_if_needed(tport_t *self,
569 struct sigcomp_compartment *cc);
571struct sigcomp_udvm **tport_get_udvm_slot(tport_t *self);
573void tport_sigcomp_accept_incomplete(tport_t *self,
msg_t *msg);
575int tport_recv_comp_dgram(tport_t
const *self,
576 tport_compressor_t *sc,
581ssize_t tport_send_comp(tport_t
const *self,
585 struct sigcomp_compartment *cc,
586 tport_compressor_t *sc);
Transport name.
Definition tport.h:156
Interface towards stack.
Definition tport.h:93
struct addrinfo su_addrinfo_t
struct su_root_t su_root_t
SU_ROOT_MAGIC_T su_root_magic_t
struct su_timer_s su_timer_t
TP_STACK_T tp_stack_t
Type of stack object.
Definition tport.h:71
TP_MAGIC_T tp_magic_t
Type of transport-protocol-specific context object.
Definition tport.h:78
Transport plugin interface.
TPORT_STUN_SERVER_T tport_stun_server_t
Safe type for tport server object.
Definition tport_plugins.h:43
tport_via
Define how the public transport connects to Internet.
Definition tport_tag.h:81