Sip Endpoint SDK for Apple OS
|
#import <GSConnection.h>
Public Member Functions | |
(GSResult) | - enable |
(GSResult) | - disable |
Properties | |
GSConnectionState | state |
NSString * | server |
NSString * | transport |
NSString * | user |
NSNumber * | registrationTimeout |
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 8 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.
- (NSNumber*) registrationTimeout [read, write, retain] |
The period after which registration should expire. A new "REGISTER" request will be sent 5 seconds before expiration. If this property is not set or equal to 0, the default timeout value is 5 minutes.
Definition at line 34 of file GSConnection.h.
- (NSString*) server [read, copy] |
The server address
Definition at line 18 of file GSConnection.h.
- (GSConnectionState) state [read, assign] |
The current connection state
Definition at line 13 of file GSConnection.h.
- (NSString*) transport [read, copy] |
The transport protocol to use when communicating with this server. Possible values are "tcp" or "udp"
Definition at line 23 of file GSConnection.h.
- (NSString*) user [read, copy] |
The user id for this connection
Definition at line 28 of file GSConnection.h.