Tribblix: manual page: sip_disable_trans

SIP_ENABLE_TRANS_LOGGING(3SIP) Session Initiation Protocol Library Functions

NAME

sip_enable_trans_logging, sip_enable_dialog_logging,
sip_disable_dialog_logging, sip_disable_trans_logging - transaction
and dialog logging operations

SYNOPSIS

cc [ flag... ] file... -lsip [ library... ]
#include <sip.h>

int sip_enable_trans_logging(FILE *logfile, int flags);

int sip_enable_dialog_logging(FILE *logfile, int flags);

void sip_disable_dialog_logging();

void sip_disable_trans_logging();

DESCRIPTION

The sip_enable_trans_logging() and sip_enable_dialog_logging()
functions enable transaction and dialog logging respectively. The
logfile argument points to a file to which the SIP messages are
logged. The flags argument controls the amount of logging. The only
flag defined in <sip.h> is SIP_DETAIL_LOGGING. Either transaction or
dialog logging, or both, can be enabled at any time. For dialog
logging to work, the SIP stack must be enabled to manage dialogs
(using SIP_STACK_DIALOGS, see sip_stack_init(3SIP)) when the stack is
initialized.

All the messages exchanged within a transaction/dialog is captured
and later dumped to a log file when the transaction or dialog is
deleted or terminated. Upon termination, each dialog writes to the
file the messages that were processed in its context. Similarly, upon
termination each transaction writes to the file the messages that
were processed in its context.

The sip_disable_trans_logging() and sip_disable_dialog_logging()
functions disable the transaction or dialog logging. These functions
do not close the files. It is the responsibility of the application
to close them.

The log contains the state of the transaction or dialog at the time
the message was processed.

RETURN VALUES

Upon successful completion, sip_enable_trans_logging() and
sip_enable_dialog_logging() return 0. They return EINVAL if logfile
is NULL or flags is unrecognized.

EXAMPLES

Example 1: Dialog logging

The following is an example of dialog logging.

FILE *logfile;

logfile = fopen("/tmp/ApplicationA", "a+");
sip_enable_dialog_logging(logfile, SIP_DETAIL_LOGGING);

/* Application sends INVITE, receives 180 and 200 response and dialog is
created. */
/* Application sends ACK request */
/* Application sends BYE and receives 200 response */

/* Application disables logging */
sip_disable_dialog_logging();

The log file will be of the following format.

************* Begin Dialog *************
Digest : 43854 43825 26120 9475 5415 21595 25658 18538

-----------------------------
Dialog State : SIP_DLG_NEW

Tue Nov 27 15:53:34 2007| Message - 1
INVITE sip:user@example.com SIP/2.0
From: "Me" < sip:me@my.example.com > ; TAG=tag-from-01
To: "You" < sip:you@your.example.com >
Contact: < sip:myhome.example.com >
MAX-FORWARDS: 70
Call-ID: 1261K6A6492KF33549XM
CSeq: 111 INVITE
CONTENT-TYPE: application/sdp
Via: SIP/2.0/UDP 192.0.0.1 : 5060 ;branch=z9hG4bK-via-EVERYTHINGIDO-05
Record-Route: <sip:server1.example.com;lr>
Record-Route: <sip:server2.example.com;lr>
CONTENT-LENGTH : 0

Tue Nov 27 15:53:34 2007| Message - 2
SIP/2.0 180 Ringing
Via: SIP/2.0/UDP 192.0.0.1 : 5060 ;branch=z9hG4bK-via-EVERYTHINGIDO-05
From: "Me" < sip:me@my.example.com > ; TAG=tag-from-01
To: "You" < sip:you@your.example.com >;tag=1
Call-ID: 1261K6A6492KF33549XM
CSeq: 111 INVITE
Contact: <sip:whitestar2-0.East.Example.COM:5060;transport=UDP>
Record-Route: <sip:server1.example.com;lr>
Record-Route: <sip:server2.example.com;lr>
Content-Length: 0

-----------------------------
Dialog State : SIP_DLG_EARLY

/* Entire 200 OK SIP Response */

-----------------------------
Dialog State : SIP_DLG_CONFIRMED

/* Entire ACK Request */

/* Entire BYE Request */
/* Entire 200 OK Response */
-----------------------------
************* End Dialog *************

ATTRIBUTES