Sip Endpoint SDK for Apple OS
|
#import <GSConnection.h>
Public Member Functions | |
(GSResult) | - enable |
(GSResult) | - disable |
Properties | |
int | connectionId |
GSConnectionState | state |
NSString * | server |
NSString * | transport |
NSString * | user |
NSNumber * | registrationTimeout |
NSNumber * | regInterval |
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 17 of file GSConnection.h.
- (GSResult) disable |
Disables the current connection
- (GSResult) enable |
Enables the current connection. The connection will be available for SIP message handling upon successful completion.
|
readnonatomicassign |
The connection ID
Definition at line 22 of file GSConnection.h.
|
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.
Definition at line 59 of file GSConnection.h.
|
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).
Definition at line 50 of file GSConnection.h.
|
readnonatomiccopy |
The server address
Definition at line 32 of file GSConnection.h.
|
readnonatomicassign |
The current connection state
Definition at line 27 of file GSConnection.h.
|
readnonatomiccopy |
The transport protocol to use when communicating with this server. Possible values are "tcp" or "udp"
Definition at line 37 of file GSConnection.h.
|
readnonatomiccopy |
The user id for this connection
Definition at line 42 of file GSConnection.h.