SipStack

java.lang.Object
- org.zoolu.util.Configure
- - org.mjsip.sip.provider.SipStack

```
public class SipStack
extends Configure
```
SipStack collects all static attributes used by the sip stack.
SipStack attributes are: the default SIP port, deafult supported transport protocols, timeouts, log configuration, etc.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String[]`	`allowed_methods` List of supported methods.
`static java.lang.String`	`authors` Authors
`static boolean`	`auto_prack` Whether automatically sending PRACK messsages for incoming reliable 1xx responses in an INVITE dialog.
`static boolean`	`auto_trying` Whether at UAS side automatically sending (by default) a 100 Trying on INVITE.
`static long`	`clearing_timeout` clearing timeout (milliseconds); T4 in RFC2361; they suggest T4=5sec
`static int`	`debug_level` Log level.
`static int`	`default_expires` Default 'expires' value in seconds.
`static int`	`default_nmax_connections` Default max number of contemporary open transport connections.
`static int`	`default_port` Default SIP port.
`static int`	`default_session_interval` Default session interval (Session-Expires header field) for supporting "Session Timers" (RFC 4028).
`static java.lang.String`	`default_tls_cert_file` For TLS.
`static java.lang.String`	`default_tls_key_file` For TLS.
`static int`	`default_tls_port` Default SIP port for TLS transport (SIPS).
`static boolean`	`default_tls_trust_all` For TLS.
`static java.lang.String`	`default_tls_trust_folder` For TLS.
`static java.lang.String[]`	`default_tls_trusted_certs` For TLS. names of the files containing trusted certificates.
`static java.lang.String[]`	`default_transport_protocols` Default supported transport protocols.
`static boolean`	`early_dialog` Whether 1xx responses create an "early dialog" for methods that create dialog.
`static java.lang.String`	`event_log_filename` Event log file name; the log file will be opened only when method init() is called
`static Logger`	`event_logger` Event logger.
`static boolean`	`force_rport` Whether adding (forcing) 'rport' parameter on via header fields of incoming requests.
`static java.lang.String`	`log_path` Path for the log folder where log files are written.
`static int`	`log_rotations` The number of rotations of log files.
`static int`	`max_forwards` default max-forwards value (RFC3261 recommends value 70)
`static int`	`max_logsize` The size limit of the log file [kB]
`static long`	`max_retransmission_timeout` maximum retransmission timeout (milliseconds); called T2 in RFC2361; they suggest T2=4sec
`static java.lang.String`	`message_log_filename` Message log file name; the log file will be opened only when method init() is called
`static Logger`	`message_logger` Message logger.
`static int`	`min_session_interval` Minimum session interval (Min-SE header field) for supporting "Session Timers" (RFC 4028).
`static boolean`	`on_dialog_route` Whether forcing this node to stay within the dialog route as peer, by means of the insertion of a RecordRoute header.
`static java.lang.String`	`OTAG_100rel` Extension option tag "100rel".
`static java.lang.String`	`OTAG_precondition` Extension option tag "precondition".
`static java.lang.String`	`OTAG_timer` Extension option tag "timer".
`static int`	`regc_auth_attempts` maximum number of consecutive registration authentication attempts before giving up
`static long`	`regc_max_attempt_timeout` maximum registration timeout (msecs) after a registration failure due to request timeout
`static long`	`regc_min_attempt_timeout` starting registration timeout (msecs) after a registration failure due to request timeout
`static java.lang.String`	`release` Release
`static java.lang.String[]`	`required_option_tags` Required option-tags for corresponding required extensions.
`static long`	`retransmission_timeout` starting retransmission timeout (milliseconds); called T1 in RFC2361; they suggest T1=500ms
`static int`	`rotation_scale` The rotation time scale
`static int`	`rotation_time` The rotation time value
`static java.lang.String`	`server_info` Server info included in response messages in the 'Server' header field Use "NONE" if the 'Server' header filed must not be added.
`static java.lang.String[]`	`supported_option_tags` Supported option-tags for corresponding supported extensions.
`static boolean`	`timer_daemon_mode` Whether the default timer mode is 'daemon', or not.
`static long`	`transaction_timeout` transaction timeout (milliseconds); RFC2361 suggests 64*T1=32000ms
`static java.lang.String`	`ua_info` UA info included in request messages in the 'User-Agent' header field.
`static boolean`	`use_rport` Whether adding 'rport' parameter on via header fields of outgoing requests.
`static java.lang.String`	`version` Version

Fields inherited from class org.zoolu.util.Configure
NONE

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`init()` Inits SipStack
`static void`	`init(java.lang.String file)` Inits SipStack from the specified file
`static boolean`	`isInit()` Whether SipStack has been already initialized
`protected void`	`parseLine(java.lang.String line)` Parses a single text line (read from the config file)
`protected java.lang.String`	`toLines()` Converts the entire object into lines (to be saved into the config file)

Methods inherited from class org.zoolu.util.Configure
loadFile, loadFile, readFrom, saveFile, writeTo

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - version
```
public static final java.lang.String version
```
    Version
    
    See Also:
    
    Constant Field Values
  - release
```
public static final java.lang.String release
```
    Release
    
    See Also:
    
    Constant Field Values
  - authors
```
public static final java.lang.String authors
```
    Authors
    
    See Also:
    
    Constant Field Values
  - OTAG_100rel
```
public static final java.lang.String OTAG_100rel
```
    Extension option tag "100rel".
    
    See Also:
    
    Constant Field Values
  - OTAG_timer
```
public static final java.lang.String OTAG_timer
```
    Extension option tag "timer".
    
    See Also:
    
    Constant Field Values
  - OTAG_precondition
```
public static final java.lang.String OTAG_precondition
```
    Extension option tag "precondition".
    
    See Also:
    
    Constant Field Values
  - default_port
```
public static int default_port
```
    Default SIP port. Note that this is not the port used by the running stack, but simply the standard default SIP port.
    Normally it sould be set to 5060 as defined by RFC 3261. Using a different value may cause some problems when interacting with other unaware SIP UAs.
  - default_tls_port
```
public static int default_tls_port
```
    Default SIP port for TLS transport (SIPS). Note that this is not the port used by the running stack, but simply the standard default SIPS port.
    Normally it sould be set to 5061 as defined by RFC 3261. Using a different value may cause some problems when interacting with other unaware SIP UAs.
  - default_transport_protocols
```
public static java.lang.String[] default_transport_protocols
```
    Default supported transport protocols.
  - default_nmax_connections
```
public static int default_nmax_connections
```
    Default max number of contemporary open transport connections.
  - use_rport
```
public static boolean use_rport
```
    Whether adding 'rport' parameter on via header fields of outgoing requests.
  - force_rport
```
public static boolean force_rport
```
    Whether adding (forcing) 'rport' parameter on via header fields of incoming requests.
  - default_tls_trust_all
```
public static boolean default_tls_trust_all
```
    For TLS. Whether all client and server certificates should be considered trusted.
  - default_tls_trusted_certs
```
public static java.lang.String[] default_tls_trusted_certs
```
    For TLS. names of the files containing trusted certificates. The file names include the full path starting from the current working folder.
  - default_tls_trust_folder
```
public static java.lang.String default_tls_trust_folder
```
    For TLS. Path of the folder where trusted certificates are placed. All certificates (with file extension ".crt") found in this folder are considered trusted.
  - default_tls_cert_file
```
public static java.lang.String default_tls_cert_file
```
    For TLS. Absolute file name of the certificate (containing the public key) of the local node. The file name includes the full path starting from the current working folder.
  - default_tls_key_file
```
public static java.lang.String default_tls_key_file
```
    For TLS. Absolute file name of the private key of the local node. The file name includes the full path starting from the current working folder.
  - retransmission_timeout
```
public static long retransmission_timeout
```
    starting retransmission timeout (milliseconds); called T1 in RFC2361; they suggest T1=500ms
  - max_retransmission_timeout
```
public static long max_retransmission_timeout
```
    maximum retransmission timeout (milliseconds); called T2 in RFC2361; they suggest T2=4sec
  - transaction_timeout
```
public static long transaction_timeout
```
    transaction timeout (milliseconds); RFC2361 suggests 64*T1=32000ms
  - clearing_timeout
```
public static long clearing_timeout
```
    clearing timeout (milliseconds); T4 in RFC2361; they suggest T4=5sec
  - max_forwards
```
public static int max_forwards
```
    default max-forwards value (RFC3261 recommends value 70)
  - timer_daemon_mode
```
public static boolean timer_daemon_mode
```
    Whether the default timer mode is 'daemon', or not. In 'daemon' mode, when all other threads terminate, the program also ends regardless the timer was still running, and no timeout callback is fired. In 'non-daemon' mode, the program ends only when all active timers have expired or explicitly halted.
  - auto_trying
```
public static boolean auto_trying
```
    Whether at UAS side automatically sending (by default) a 100 Trying on INVITE.
  - early_dialog
```
public static boolean early_dialog
```
    Whether 1xx responses create an "early dialog" for methods that create dialog.
  - auto_prack
```
public static boolean auto_prack
```
    Whether automatically sending PRACK messsages for incoming reliable 1xx responses in an INVITE dialog.
    Note that if you set true, the PRACK messge are sent automatically without any message body. This may be in contrast with a possible offer/answer use of reliable 1xx response and PRACK.
  - default_expires
```
public static int default_expires
```
    Default 'expires' value in seconds. RFC2361 suggests 3600s as default value.
  - ua_info
```
public static java.lang.String ua_info
```
    UA info included in request messages in the 'User-Agent' header field. Use "NONE" if the 'User-Agent' header filed must not be added.
  - server_info
```
public static java.lang.String server_info
```
    Server info included in response messages in the 'Server' header field Use "NONE" if the 'Server' header filed must not be added.
  - supported_option_tags
```
public static java.lang.String[] supported_option_tags
```
    Supported option-tags for corresponding supported extensions.
  - required_option_tags
```
public static java.lang.String[] required_option_tags
```
    Required option-tags for corresponding required extensions.
  - allowed_methods
```
public static java.lang.String[] allowed_methods
```
    List of supported methods.
  - min_session_interval
```
public static int min_session_interval
```
    Minimum session interval (Min-SE header field) for supporting "Session Timers" (RFC 4028).
  - default_session_interval
```
public static int default_session_interval
```
    Default session interval (Session-Expires header field) for supporting "Session Timers" (RFC 4028).
  - regc_min_attempt_timeout
```
public static long regc_min_attempt_timeout
```
    starting registration timeout (msecs) after a registration failure due to request timeout
  - regc_max_attempt_timeout
```
public static long regc_max_attempt_timeout
```
    maximum registration timeout (msecs) after a registration failure due to request timeout
  - regc_auth_attempts
```
public static int regc_auth_attempts
```
    maximum number of consecutive registration authentication attempts before giving up
  - debug_level
```
public static int debug_level
```
    Log level. Only logs with a level less or equal to this are written. Default value: debug_level=0, that means no logs.
  - log_path
```
public static java.lang.String log_path
```
    Path for the log folder where log files are written. By default, it is used the current "." folder.
  - max_logsize
```
public static int max_logsize
```
    The size limit of the log file [kB]
  - log_rotations
```
public static int log_rotations
```
    The number of rotations of log files. Use '0' for NO rotation, '1' for rotating a single file
  - rotation_scale
```
public static int rotation_scale
```
    The rotation time scale
  - rotation_time
```
public static int rotation_time
```
    The rotation time value
  - event_log_filename
```
public static java.lang.String event_log_filename
```
    Event log file name; the log file will be opened only when method init() is called
  - event_logger
```
public static Logger event_logger
```
    Event logger. If 'null', a different event log file is instantiated for each SIP provider. Default value: event_logger=null
  - message_log_filename
```
public static java.lang.String message_log_filename
```
    Message log file name; the log file will be opened only when method init() is called
  - message_logger
```
public static Logger message_logger
```
    Message logger. If 'null', a different message log file is instantiated for each SIP provider. Default value: message_logger=null
  - on_dialog_route
```
public static boolean on_dialog_route
```
    Whether forcing this node to stay within the dialog route as peer, by means of the insertion of a RecordRoute header. This is a non-standard behaviour and is normally not necessary.
- Method Detail
  - parseLine
```
protected void parseLine(java.lang.String line)
```
    Parses a single text line (read from the config file)
    
    Overrides:
    
    parseLine in class Configure
  - toLines
```
protected java.lang.String toLines()
```
    Converts the entire object into lines (to be saved into the config file)
    
    Overrides:
    
    toLines in class Configure
  - init
```
public static void init()
```
    Inits SipStack
  - init
```
public static void init(java.lang.String file)
```
    Inits SipStack from the specified file
  - isInit
```
public static boolean isInit()
```
    Whether SipStack has been already initialized

Class SipStack

Field Summary

Fields inherited from class org.zoolu.util.Configure

Method Summary

Methods inherited from class org.zoolu.util.Configure

Methods inherited from class java.lang.Object

Field Detail

version

release

authors

OTAG_100rel

OTAG_timer

OTAG_precondition

default_port

default_tls_port

default_transport_protocols

default_nmax_connections

use_rport

force_rport

default_tls_trust_all

default_tls_trusted_certs

default_tls_trust_folder

default_tls_cert_file

default_tls_key_file

retransmission_timeout

max_retransmission_timeout

transaction_timeout

clearing_timeout

max_forwards

timer_daemon_mode

auto_trying

early_dialog

auto_prack

default_expires

ua_info

server_info

supported_option_tags

required_option_tags

allowed_methods

min_session_interval

default_session_interval

regc_min_attempt_timeout

regc_max_attempt_timeout

regc_auth_attempts

debug_level

log_path

max_logsize

log_rotations

rotation_scale

rotation_time

event_log_filename

event_logger

message_log_filename

message_logger

on_dialog_route

Method Detail

parseLine

toLines

init

init

isInit