Thu Apr 16 06:48:57 2015

Asterisk developer's documentation


ast_tcptls_stream Struct Reference

Collaboration diagram for ast_tcptls_stream:

Collaboration graph
[legend]

Data Fields

int exclusive_input
int fd
 The socket returned by accept().
SSLssl
struct timeval start
 Start time from when an I/O sequence must complete by struct ast_tcptls_stream.timeout.
int timeout
 Timeout in ms relative to struct ast_tcptls_stream.start to wait for an event on struct ast_tcptls_stream.fd.

Detailed Description

ao2 object used for the FILE stream fopencookie()/funopen() cookie.

Definition at line 54 of file tcptls.c.


Field Documentation

TRUE if stream can exclusively wait for fd input.

Definition at line 81 of file tcptls.c.

Referenced by ast_tcptls_stream_set_exclusive_input(), and tcptls_stream_read().

int fd

The socket returned by accept().

Note:
Set to -1 if the stream is closed.

Definition at line 70 of file tcptls.c.

Referenced by ast_tcptls_server_read(), ast_tcptls_server_write(), tcptls_stream_alloc(), tcptls_stream_close(), tcptls_stream_dtor(), tcptls_stream_fopen(), tcptls_stream_read(), and tcptls_stream_write().

SSL* ssl

SSL state if not NULL

Definition at line 56 of file tcptls.c.

Referenced by tcptls_stream_close(), tcptls_stream_fopen(), tcptls_stream_read(), and tcptls_stream_write().

struct timeval start [read]

Start time from when an I/O sequence must complete by struct ast_tcptls_stream.timeout.

Note:
If struct ast_tcptls_stream.start.tv_sec is zero then start time is the current I/O request.

Definition at line 64 of file tcptls.c.

Referenced by ast_tcptls_stream_set_timeout_inactivity(), ast_tcptls_stream_set_timeout_sequence(), tcptls_stream_read(), and tcptls_stream_write().

int timeout

Timeout in ms relative to struct ast_tcptls_stream.start to wait for an event on struct ast_tcptls_stream.fd.

Note:
Set to -1 to disable timeout.

The socket needs to be set to non-blocking for the timeout feature to work correctly.

Definition at line 79 of file tcptls.c.

Referenced by ast_tcptls_stream_set_timeout_disable(), ast_tcptls_stream_set_timeout_inactivity(), ast_tcptls_stream_set_timeout_sequence(), tcptls_stream_alloc(), tcptls_stream_fopen(), tcptls_stream_read(), and tcptls_stream_write().


The documentation for this struct was generated from the following file:

Generated on Thu Apr 16 06:48:57 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6