Skip to content

Commit

Permalink
modules: readme files regenerated - acc ...
Browse files Browse the repository at this point in the history
  • Loading branch information
@kamailio-dev
kamailio-dev committed Jan 2, 2017
1 parent c2c7e5b commit c180e95
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 58 deletions.
30 changes: 8 additions & 22 deletions src/modules/acc/README
View file
Expand Up @@ -319,7 +319,10 @@ Chapter 1. Admin Guide
1.1. General Example

ACC module is used to account transactions information to different
backends like syslog, SQL, RADIUS and DIAMETER (beta version).
backends like syslog and SQL. With the separate module, radius support
is enabled. There is some very early support of the Diameter protocol
in the code which is no longer included by default. This support is not
up to date with the current Diameter protocols and is disabled.

To account a transaction and to choose which set of backends to be
used, the script writer just has to set some flags (see the module
Expand Down Expand Up @@ -364,25 +367,9 @@ Chapter 1. Admin Guide
see cdr_expired_dlg_enable parameter - Section 6.40,
“cdr_expired_dlg_enable (integer)”.

The SQL backend support is compiled in the module. For RADIUS and
DIAMETER you need to enable it by recompiling the module with properly
set defines: uncomment the RAD_ACC or DDIAM_ACC lines in
modules/acc/Makefile. To compile RADIUS support, you need to have
radiusclient-ng (only versions higher or equal to 0.5.0) installed on
your system which is available from
http://developer.berlios.de/projects/radiusclient-ng/. The radius
client needs to be configured properly. To do so, use the template at
etc/radiusclient.conf and make sure that module's radius_config
parameter points to its location. In particular, accounting secret must
match that one configured in server and proper dictionary is used (one
is available at etc/sip_dictionary). Also note that Debian
radiusclient-ng uses /var/run/radius.seq as seqfile but Kamailio Debian
init script expects /var/run/kamailio/kamailio_radius.seq, so is needed
to change it in radiusclient-ng configuration or in Kamailio Debian
init script (if not, Kamailio can't create the seq file when not
running as root). Uses along with FreeRadius (
http://www.freeradius.org/) and Radiator (
http://www.open.com.au/radiator/) servers have been reported to us.
The SQL backend support is compiled in the module. For DIAMETER you
need to enable it by recompiling the module with properly set defines:
uncomment the DDIAM_ACC lines in modules/acc/Makefile.

NOTE: diameter support was developed for DISC (DIameter Server Client
project at http://developer.berlios.de/projects/disc/). This project
Expand Down Expand Up @@ -669,8 +656,7 @@ $dlg_var(callee) = $avp(callee); #callee='C'

The following libraries or applications must be installed before
running Kamailio with this module loaded:
* radiusclient-ng 0.5.0 or higher -- if compiled with RADIUS support.
See http://developer.berlios.de/projects/radiusclient-ng/.
* None

6. Parameters

Expand Down
58 changes: 33 additions & 25 deletions src/modules/http_client/README
View file
Expand Up @@ -85,14 +85,15 @@ Hugh Waite

2. Developer Guide

1. Available Functions
1.
2. Available Functions

1.1. http_connect(msg, connection, url, result,
2.1. int http_connect(msg, connection, url, result,
content_type, post)

1.2. int http_connection_exists(str *connection)
1.3. http_query(msg, url, dest, post)
1.4. http_get_content_type(str connection)
2.2. int http_connection_exists(str *connection)
2.3. int http_query(msg, url, dest, post)
2.4. http_get_content_type(str connection)

List of Examples

Expand Down Expand Up @@ -175,7 +176,8 @@ Chapter 1. Admin Guide
This module implements protocol functions that use the libcurl library
to fetch data from external HTTP servers or post data to HTTP servers.
The module is using a concept of "connections" to define properties of
HTTP sessions in a simple way.
HTTP sessions in a simple way. A connection has one or multiple servers
and a set of settings that apply to the specific connection.

The http_client module has multiple settings, some of them applies to a
defined connection. You can set timeouts, max data sizes for download
Expand All @@ -191,9 +193,10 @@ Chapter 1. Admin Guide
Transformation Cookbook (as used in the http_client_query example
below).

Function http_client_query allows Kamailio to issue an HTTP GET request
and get access to parts of the reply. This function has been ported
from the utils module and now use the same libcurl functions.
The function http_client_query allows Kamailio to issue an HTTP GET
request and get access to parts of the reply. This function has been
ported from the utils module and now use the same libcurl functions. We
recommend using the new functionality provided by this module.

The http_client module use the CURL library setting up connections. The
CURL library by default use the system configured DNS resolvers, not
Expand Down Expand Up @@ -760,23 +763,28 @@ Chapter 2. Developer Guide

Table of Contents

1. Available Functions
1.
2. Available Functions

1.1. http_connect(msg, connection, url, result, content_type,
2.1. int http_connect(msg, connection, url, result, content_type,
post)

1.2. int http_connection_exists(str *connection)
1.3. http_query(msg, url, dest, post)
1.4. http_get_content_type(str connection)
2.2. int http_connection_exists(str *connection)
2.3. int http_query(msg, url, dest, post)
2.4. http_get_content_type(str connection)

1. Available Functions
This module provides a set of API functions that other modules can use
in order to integrate with HTTP services.

1.1. http_connect(msg, connection, url, result, content_type, post)
1.2. int http_connection_exists(str *connection)
1.3. http_query(msg, url, dest, post)
1.4. http_get_content_type(str connection)
2. Available Functions

1.1. http_connect(msg, connection, url, result, content_type, post)
2.1. int http_connect(msg, connection, url, result, content_type, post)

2.2. int http_connection_exists(str *connection)
2.3. int http_query(msg, url, dest, post)
2.4. http_get_content_type(str connection)

2.1. int http_connect(msg, connection, url, result, content_type, post)

Sends HTTP GET or POST request to a given connection. If content_type
and post are NULL GET will be used. If post is not null the data will
Expand Down Expand Up @@ -805,24 +813,24 @@ Chapter 2. Developer Guide
A string containing the message body to send. Use NULL when a
message body is not required.

1.2. int http_connection_exists(str *connection)
2.2. int http_connection_exists(str *connection)

Check if a connection definition exists. Connections are defined as
modparam's in the http_client modules.

Returns 1 if the connection exists, 0 if a connection with the given
name can't be found.

1.3. http_query(msg, url, dest, post)
2.3. int http_query(msg, url, dest, post)

Sends HTTP GET or POST request to a given connection. If post data is
Sends a HTTP GET or POST request to a given connection. If post data is
defined, POST will be used, otherwise GET. The default settings defined
as module params of the http_client module will be used for the
connection.

Meaning of the parameters is as follows:
* struct sip_msg *msg
The current sip message structure.
The current SIP message structure.
* const char *url
A string that will be used as the URL specified in the connection.
* str *dest
Expand All @@ -832,7 +840,7 @@ Chapter 2. Developer Guide
* const char *post
If not null, the data will be posted to the URL.

1.4. http_get_content_type(str connection)
2.4. http_get_content_type(str connection)

Get the content-type of the last result for this connection. This will
be something like "text/html" for html or "application/json" for JSON
Expand Down
21 changes: 10 additions & 11 deletions src/modules/websocket/README
View file
Expand Up @@ -124,10 +124,10 @@ Chapter 1. Admin Guide
This module implements a WebSocket (RFC 6455) server and provides
connection establishment (handshaking), management (including
connection keep-alive), and framing for the SIP and MSRP WebSocket
sub-protocols (draft-ietf-sipcore-sip-websocket and
draft-pd-msrp-websocket).
sub-protocols (RFC 7118 and RFC 7977).

The module supports WebSockets (ws) and secure WebSockets (wss)
transports

2. How it works

Expand Down Expand Up @@ -218,11 +218,11 @@ event_route[xhttp:request] {
WebSocket connection is made. This means that the routing headers
cannot be used for request or response routing in the normal manner.

draft-ietf-sipcore-sip-websocket states that SIP WebSocket Clients and
the SIP registrar should implement Outbound (RFC 5626) and Path (RFC
3327) to enable requests and responses to be correctly routed. However,
Kamailio does not currently support Outbound and it may not be possible
to guarantee all SIP WebSocket clients will support Outbound and Path.
RFC 7118 - The WebSocket Protocol as a Transport for the Session
Initiation Protocol - states that SIP WebSocket Clients and the SIP
registrar should implement SIP Outbound (RFC 5626) and Path header
support (RFC 3327) to enable requests and responses to be correctly
routed. Kamailio has a module called "Outbound" for this functionality.

The nathelper module functions (nat_uac_test(), fix_nated_register(),
add_contact_alias(), and handle_ruri_alias()) and the Kamailio core
Expand Down Expand Up @@ -386,7 +386,7 @@ modparam("websocket", "keepalive_processes", 2)

4.4. keepalive_interval (integer)

The number of seconds between each keep-alice process run
The number of seconds between each keep-alive process run

Default value is 1.

Expand All @@ -410,9 +410,8 @@ modparam("websocket", "ping_application_data", "WebSockets rock")

A bitmap that allows you to control the sub-protocols supported by the
WebSocket server.
* 1 - sip (draft-ietf-sipcore-sip-websocket)
* 2 - msrp (draft-pd-msrp-websocket) - msrp.so must be loaded before
websocket.so
* 1 - sip (RFC 7118)
* 2 - msrp (RFC 7977) - msrp.so must be loaded before websocket.so

Default value is 1 when msrp.so is not loaded 3 when msrp.so is loaded.

Expand Down

0 comments on commit c180e95

Please sign in to comment.