.TH "base.h" 3 "Sat Oct 27 2018" "ccRTP" \" -*- nroff -*-
.ad l
.nh
.SH NAME
base.h \- Base elements for RTP stacks: constants, types and global functions\&.  

.SH SYNOPSIS
.br
.PP
\fC#include <commoncpp/config\&.h>\fP
.br
\fC#include <commoncpp/socket\&.h>\fP
.br
\fC#include <commoncpp/udp\&.h>\fP
.br

.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBCCXX_PACKED\fP"
.br
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef uint32 \fBmicrotimeout_t\fP"
.br
.RI "Time interval expressed in microseconds\&. "
.ti -1c
.RI "typedef uint32 \fBnanotimeout_t\fP"
.br
.RI "Time interval expressed in nanoseconds\&. "
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "__EXPORT timeval \fBmicrotimeout2Timeval\fP (\fBmicrotimeout_t\fP to)"
.br
.RI "Convert a time interval, expressed as a microtimeout_t (number of microseconds), into a timeval value\&. "
.ti -1c
.RI "\fBmicrotimeout_t\fP \fBtimeval2microtimeout\fP (const timeval &t)"
.br
.RI "Convert a time interval, expressed as a timeval value into a microseconds counter\&. "
.ti -1c
.RI "\fBmicrotimeout_t\fP \fBtimevalDiff2microtimeout\fP (const timeval &t1, const timeval &t2)"
.br
.RI "Convert a time interval, expressed as the difference between two timeval values (t1-t2), into a microseconds counter\&. "
.in -1c
.SS "Variables"

.in +1c
.ti -1c
.RI "const uint8 \fBCCRTP_VERSION\fP = 2"
.br
.RI "RTP protocol version supported\&. "
.ti -1c
.RI "const tpport_t \fBDefaultRTPDataPort\fP = 5004"
.br
.RI "registered default RTP data transport port "
.ti -1c
.RI "const tpport_t \fBDefaultRTCPPort\fP = 5005"
.br
.RI "registered default RTCP transport port "
.in -1c
.SH "Detailed Description"
.PP 
Base elements for RTP stacks: constants, types and global functions\&. 


.SH "Macro Definition Documentation"
.PP 
.SS "#define CCXX_PACKED"

.SH "Typedef Documentation"
.PP 
.SS "typedef uint32 \fBmicrotimeout_t\fP"

.PP
Time interval expressed in microseconds\&. 
.SS "typedef uint32 \fBnanotimeout_t\fP"

.PP
Time interval expressed in nanoseconds\&. 
.SH "Function Documentation"
.PP 
.SS "__EXPORT timeval microtimeout2Timeval (\fBmicrotimeout_t\fP to)"

.PP
Convert a time interval, expressed as a microtimeout_t (number of microseconds), into a timeval value\&. 
.PP
\fBParameters:\fP
.RS 4
\fIto\fP time interval, in microseconds\&. 
.RE
.PP
\fBReturns:\fP
.RS 4
the same time interval, as a timeval value\&. 
.RE
.PP

.SS "\fBmicrotimeout_t\fP timeval2microtimeout (const timeval & t)\fC [inline]\fP"

.PP
Convert a time interval, expressed as a timeval value into a microseconds counter\&. 
.PP
\fBParameters:\fP
.RS 4
\fIt\fP time, as a timeval\&. 
.RE
.PP
\fBReturns:\fP
.RS 4
the same time, as a microseconds counter\&. 
.RE
.PP

.SS "\fBmicrotimeout_t\fP timevalDiff2microtimeout (const timeval & t1, const timeval & t2)\fC [inline]\fP"

.PP
Convert a time interval, expressed as the difference between two timeval values (t1-t2), into a microseconds counter\&. 
.PP
\fBParameters:\fP
.RS 4
\fIt1\fP First timeval\&. 
.br
\fIt2\fP Second timeval\&. 
.RE
.PP
\fBReturns:\fP
.RS 4
difference between t1 and t2, in microseconds\&. 
.RE
.PP

.SH "Variable Documentation"
.PP 
.SS "const uint8 CCRTP_VERSION = 2"

.PP
RTP protocol version supported\&. 
.SS "const tpport_t DefaultRTCPPort = 5005"

.PP
registered default RTCP transport port 
.SS "const tpport_t DefaultRTPDataPort = 5004"

.PP
registered default RTP data transport port 
.SH "Author"
.PP 
Generated automatically by Doxygen for ccRTP from the source code\&.