modules_k/osp/osptoolkit.h

00001 /*
00002  * openser osp module. 
00003  *
00004  * This module enables openser to communicate with an Open Settlement 
00005  * Protocol (OSP) server.  The Open Settlement Protocol is an ETSI 
00006  * defined standard for Inter-Domain VoIP pricing, authorization
00007  * and usage exchange.  The technical specifications for OSP 
00008  * (ETSI TS 101 321 V4.1.1) are available at www.etsi.org.
00009  *
00010  * Uli Abend was the original contributor to this module.
00011  * 
00012  * Copyright (C) 2001-2005 Fhg Fokus
00013  *
00014  * This file is part of Kamailio, a free SIP server.
00015  *
00016  * Kamailio is free software; you can redistribute it and/or modify
00017  * it under the terms of the GNU General Public License as published by
00018  * the Free Software Foundation; either version 2 of the License, or
00019  * (at your option) any later version
00020  *
00021  * Kamailio is distributed in the hope that it will be useful,
00022  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00023  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00024  * GNU General Public License for more details.
00025  *
00026  * You should have received a copy of the GNU General Public License
00027  * along with this program; if not, write to the Free Software
00028  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00029  */
00030 
00031 #ifndef _OSP_MOD_OSPTOOLKIT_H_
00032 #define _OSP_MOD_OSPTOOLKIT_H_
00033 
00034 #include <osp/osp.h>
00035 
00036 /* 
00037  * This module implements help functions for the OSP toolkit.
00038  * Some of the functions maybe impemented by the toolkit in the future.
00039  */
00040 
00041 /* 
00042  * Returns the OSP transaction id generated by the server.  The id is
00043  * returned in the Authorization Response and also packaged in the token.
00044  */
00045 unsigned long long ospGetTransactionId(OSPTTRANHANDLE transaction);
00046 void ospReportUsageWrapper(
00047     OSPTTRANHANDLE ospvTransaction,     /* In - Transaction handle */
00048     unsigned ospvReleaseCode,           /* In - Release code */
00049     unsigned ospvDuration,              /* In - Length of call */
00050     time_t ospvStartTime,               /* In - Call start time */
00051     time_t ospvEndTime,                 /* In - Call end time */
00052     time_t ospvAlertTime,               /* In - Call alert time */
00053     time_t ospvConnectTime,             /* In - Call connect time */
00054     unsigned ospvIsPDDInfoPresent,      /* In - Is PDD Info present */
00055     unsigned ospvPostDialDelay,         /* In - Post Dial Delay */
00056     unsigned ospvReleaseSource          /* In - EP that released the call */
00057 );
00058 
00059 #endif /* _OSP_MOD_OSPTOOLKIT_H_ */
00060