SIP Endpoint SDK for OS X
 All Classes Functions Properties
<GSConnection> Protocol Reference

#import <GSConnection.h>

Inheritance diagram for <GSConnection>:
GSSipConnection

List of all members.

Public Member Functions

(GSResult) - enable
(GSResult) - disable

Properties

NSString * displayName
NSString * password
NSNumber * regMatchReceivedRport
NSString * domain
NSNumber * sipPortMin
NSNumber * sipPortMax
NSNumber * rtpPortMin
NSNumber * rtpPortMax
NSNumber * iceEnabled
NSString * stunServer
NSNumber * stunServerPort
NSNumber * turnServerPort
NSString * turnUserName
NSString * turnPassword
NSNumber * turnRelayType
int connectionId
int configId
GSConnectionState state
NSString * server
NSString * transport
NSString * user
NSNumber * registrationTimeout
NSNumber * regInterval
int sipCode
NSString * reason

Detailed Description

This protocol is implemented by each SIP connection object. Users can determine the parameters for the given connection as well as toggle connection state.

Definition at line 16 of file GSConnection.h.


Member Function Documentation

- (GSResult) disable

Disables the current connection

Returns:
the result (i.e. success or failure) of performing the operation. Note that the actual connection state will be sent asynchronously.
- (GSResult) enable

Enables the current connection. The connection will be available for SIP message handling upon successful completion.

Returns:
the result (i.e. success or failure) of performing the operation. Note that the actual connection state will be sent asynchronously.

Property Documentation

- (int) configId
readnonatomicassign

The connection configuration ID

Reimplemented in GSSipConnection.

Definition at line 102 of file GSConnection.h.

- (int) connectionId
readnonatomicassign

The connection ID

Reimplemented in GSSipConnection.

Definition at line 97 of file GSConnection.h.

- (NSString*) displayName
readwritenonatomicretain

The connection display name

Reimplemented in GSSipConnection.

Definition at line 22 of file GSConnection.h.

- (NSString*) domain
readwritenonatomicretain

The connection domain name

Reimplemented in GSSipConnection.

Definition at line 37 of file GSConnection.h.

- (NSNumber*) iceEnabled
readwritenonatomicretain

The connection ICE enabled if set to 1 and disabled if 0

Reimplemented in GSSipConnection.

Definition at line 62 of file GSConnection.h.

- (NSString*) password
readwritenonatomicretain

The connection password

Reimplemented in GSSipConnection.

Definition at line 27 of file GSConnection.h.

- (NSString*) reason
readwritenonatomicretain

The registration operation reason

Reimplemented in GSSipConnection.

Definition at line 151 of file GSConnection.h.

- (NSNumber*) regInterval
readwritenonatomicretain

The period after which sip endpoint starts a new registration cycle. The valid value is => 0. If this property is not set or negative, the default timeout value is 0 means: no new reregister allowed. If this property is > 0 means: new reregister allowed and will start after the regInterval. The measurement unit is sec.

Reimplemented in GSSipConnection.

Definition at line 141 of file GSConnection.h.

- (NSNumber*) registrationTimeout
readwritenonatomicretain

The period after which registration should expire. A new "REGISTER" request will be sent before expiration. The valid value is => 0. If this property is not set or negative, the default timeout value is 1800 sec. If this property is equal to 0, registration disabled (standalone mode).

Reimplemented in GSSipConnection.

Definition at line 132 of file GSConnection.h.

- (NSNumber*) regMatchReceivedRport
readwritenonatomicretain

The connection registration received rport matching

Reimplemented in GSSipConnection.

Definition at line 32 of file GSConnection.h.

- (NSNumber*) rtpPortMax
readwritenonatomicretain

The connection RTP port maximum to be used in port range

Reimplemented in GSSipConnection.

Definition at line 57 of file GSConnection.h.

- (NSNumber*) rtpPortMin
readwritenonatomicretain

The connection RTP port minimum to be used in port range

Reimplemented in GSSipConnection.

Definition at line 52 of file GSConnection.h.

- (NSString*) server
readnonatomiccopy

The server address

Reimplemented in GSSipConnection.

Definition at line 112 of file GSConnection.h.

- (int) sipCode
readwritenonatomicassign

The registration operation SIP code

Reimplemented in GSSipConnection.

Definition at line 146 of file GSConnection.h.

- (NSNumber*) sipPortMax
readwritenonatomicretain

The connection SIP port maximum to be used in port range

Reimplemented in GSSipConnection.

Definition at line 47 of file GSConnection.h.

- (NSNumber*) sipPortMin
readwritenonatomicretain

The connection SIP port minimum to be used in port range

Reimplemented in GSSipConnection.

Definition at line 42 of file GSConnection.h.

- (GSConnectionState) state
readnonatomicassign

The current connection state

Reimplemented in GSSipConnection.

Definition at line 107 of file GSConnection.h.

- (NSString*) stunServer
readwritenonatomicretain

The connection STUN server name

Reimplemented in GSSipConnection.

Definition at line 67 of file GSConnection.h.

- (NSNumber*) stunServerPort
readwritenonatomicretain

The connection STUN server port

Reimplemented in GSSipConnection.

Definition at line 72 of file GSConnection.h.

- (NSString*) transport
readnonatomiccopy

The transport protocol to use when communicating with this server. Possible values are "tcp" or "udp"

Reimplemented in GSSipConnection.

Definition at line 118 of file GSConnection.h.

- (NSString*) turnPassword
readwritenonatomicretain

The connection TURN password

Reimplemented in GSSipConnection.

Definition at line 87 of file GSConnection.h.

- (NSNumber*) turnRelayType
readwritenonatomicretain

The connection TURN relay type

Reimplemented in GSSipConnection.

Definition at line 92 of file GSConnection.h.

- (NSNumber*) turnServerPort
readwritenonatomicretain

The connection TURN server port

Reimplemented in GSSipConnection.

Definition at line 77 of file GSConnection.h.

- (NSString*) turnUserName
readwritenonatomicretain

The connection TURN user name

Reimplemented in GSSipConnection.

Definition at line 82 of file GSConnection.h.

- (NSString*) user
readnonatomiccopy

The user id for this connection

Reimplemented in GSSipConnection.

Definition at line 123 of file GSConnection.h.


The documentation for this protocol was generated from the following file: