SIP Endpoint SDK for OS X
 All Classes Functions Properties
GSSipConnection Class Reference
Inheritance diagram for GSSipConnection:
GSSipAbstractionObject <GSConnection>

List of all members.

Public Member Functions

(id) - initConnectionForUser:server:transport:password:logger:core:
(void) - connectionStateChanged:
- Public Member Functions inherited from GSSipAbstractionObject
(id) - initWithLogger:
(id) - initWithLogger:core:
(id) - initWithLogger:configData:
- Public Member Functions inherited from
(GSResult) - enable
(GSResult) - disable

Properties

int connectionId
int configId
GSConnectionState state
NSString * user
NSString * server
NSString * transport
NSString * displayName
NSString * password
NSNumber * registrationTimeout
NSNumber * regInterval
NSNumber * regMatchReceivedRport
NSString * domain
NSNumber * sipPortMin
NSNumber * sipPortMax
NSNumber * rtpPortMin
NSNumber * rtpPortMax
NSNumber * iceEnabled
NSString * stunServer
NSNumber * stunServerPort
NSString * turnServer
NSNumber * turnServerPort
NSString * turnUserName
NSString * turnPassword
NSNumber * turnRelayType
int sipCode
NSString * reason
- Properties inherited from GSSipAbstractionObject
id< GSLoggerlogger
NSMutableDictionary * configuration
GSepCoreepCore
- Properties inherited from

Detailed Description

Definition at line 14 of file GSSipConnection.h.


Property Documentation

- (int) configId
readwritenonatomicassign

The connection configuration ID

Reimplemented from <GSConnection>.

Definition at line 17 of file GSSipConnection.h.

- (int) connectionId
readwritenonatomicassign

The connection ID

Reimplemented from <GSConnection>.

Definition at line 16 of file GSSipConnection.h.

- (NSString *) displayName
readwritenonatomiccopy

The connection display name

Reimplemented from <GSConnection>.

Definition at line 23 of file GSSipConnection.h.

- (NSString *) domain
readwritenonatomicretain

The connection domain name

Reimplemented from <GSConnection>.

Definition at line 29 of file GSSipConnection.h.

- (NSNumber *) iceEnabled
readwritenonatomicretain

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

Reimplemented from <GSConnection>.

Definition at line 35 of file GSSipConnection.h.

- (NSString *) password
readwritenonatomiccopy

The connection password

Reimplemented from <GSConnection>.

Definition at line 24 of file GSSipConnection.h.

- (NSString *) reason
readwritenonatomicretain

The registration operation reason

Reimplemented from <GSConnection>.

Definition at line 45 of file GSSipConnection.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 from <GSConnection>.

Definition at line 27 of file GSSipConnection.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 from <GSConnection>.

Definition at line 26 of file GSSipConnection.h.

- (NSNumber *) regMatchReceivedRport
readwritenonatomicretain

The connection registration received rport matching

Reimplemented from <GSConnection>.

Definition at line 28 of file GSSipConnection.h.

- (NSNumber *) rtpPortMax
readwritenonatomicretain

The connection RTP port maximum to be used in port range

Reimplemented from <GSConnection>.

Definition at line 33 of file GSSipConnection.h.

- (NSNumber *) rtpPortMin
readwritenonatomicretain

The connection RTP port minimum to be used in port range

Reimplemented from <GSConnection>.

Definition at line 32 of file GSSipConnection.h.

- (NSString *) server
readwritenonatomiccopy

The server address

Reimplemented from <GSConnection>.

Definition at line 21 of file GSSipConnection.h.

- (int) sipCode
readwritenonatomicassign

The registration operation SIP code

Reimplemented from <GSConnection>.

Definition at line 44 of file GSSipConnection.h.

- (NSNumber *) sipPortMax
readwritenonatomicretain

The connection SIP port maximum to be used in port range

Reimplemented from <GSConnection>.

Definition at line 31 of file GSSipConnection.h.

- (NSNumber *) sipPortMin
readwritenonatomicretain

The connection SIP port minimum to be used in port range

Reimplemented from <GSConnection>.

Definition at line 30 of file GSSipConnection.h.

- (GSConnectionState) state
readwritenonatomicassign

The current connection state

Reimplemented from <GSConnection>.

Definition at line 18 of file GSSipConnection.h.

- (NSString *) stunServer
readwritenonatomicretain

The connection STUN server name

Reimplemented from <GSConnection>.

Definition at line 36 of file GSSipConnection.h.

- (NSNumber *) stunServerPort
readwritenonatomicretain

The connection STUN server port

Reimplemented from <GSConnection>.

Definition at line 37 of file GSSipConnection.h.

- (NSString *) transport
readwritenonatomiccopy

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

Reimplemented from <GSConnection>.

Definition at line 22 of file GSSipConnection.h.

- (NSString *) turnPassword
readwritenonatomicretain

The connection TURN password

Reimplemented from <GSConnection>.

Definition at line 41 of file GSSipConnection.h.

- (NSNumber *) turnRelayType
readwritenonatomicretain

The connection TURN relay type

Reimplemented from <GSConnection>.

Definition at line 42 of file GSSipConnection.h.

- (NSNumber *) turnServerPort
readwritenonatomicretain

The connection TURN server port

Reimplemented from <GSConnection>.

Definition at line 39 of file GSSipConnection.h.

- (NSString *) turnUserName
readwritenonatomicretain

The connection TURN user name

Reimplemented from <GSConnection>.

Definition at line 40 of file GSSipConnection.h.

- (NSString *) user
readwritenonatomiccopy

The user id for this connection

Reimplemented from <GSConnection>.

Definition at line 20 of file GSSipConnection.h.


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