Sip Endpoint SDK for Apple OS
|
#import <GSConnectionManager.h>
Public Member Functions | |
(id< GSConnection >) | - addConnectionForUser:server:transport: |
(void) | - removeConnection: |
(NSArray *) | - connectionsForUser:toServer:withTransport: |
(NSArray *) | - connectionsForUser:toServer: |
(NSArray *) | - connectionsToServer: |
(NSArray *) | - connectionsToServer:withTransport: |
(NSArray *) | - allConnections |
(NSArray *) | - allSubscriptions |
(id < GSMessageWaitingIndicationService >) | - messageWaitingIndicationService |
(id< GSVideoService >) | - videoService |
This protocol defines connection manager functionality. Note: all NSArrays returned by this protocol's methods hold objects of type id<GSConnection>.
Definition at line 24 of file GSConnectionManager.h.
- (id<GSConnection>) addConnectionForUser: | (NSString *) | user | |
server: | (NSString *) | server | |
transport: | (NSString *) | transport | |
Adds a new connection
user | the user id |
server | the server address |
transport | the transport protocol (valid values are 'tcp' or 'udp') |
- (NSArray*) allConnections |
- (NSArray*) allSubscriptions |
- (NSArray*) connectionsForUser: | (NSString *) | user | |
toServer: | (NSString *) | server | |
Utility method to retrieve a snapshot of current connections for the specified user id and server.
user | the user id for the connection |
server | the server address |
- (NSArray*) connectionsForUser: | (NSString *) | user | |
toServer: | (NSString *) | server | |
withTransport: | (NSString *) | transport | |
Utility method to retrieve a snapshot of current connections for the specified user id, server and transport. Note that passing 'nil' for any parameter is acceptable and means that the parameter will be excluded from the condition. For instance: [myInstance connectionsForUser:"user1" toServer:@"server1" withTransport:nil] will return either tcp or udp connections to the specified server for the specified user.
user | the user id for the connection |
server | the server address |
transport | the transport protocol |
- (NSArray*) connectionsToServer: | (NSString *) | server |
Utility method to retrieve a snapshot of current connections to the specified server.
server | the server address |
- (NSArray*) connectionsToServer: | (NSString *) | server | |
withTransport: | (NSString *) | transport | |
Utility method to retrieve a snapshot of current connections with the specified transport to the given server.
server | the server address |
transport | the transport protocol |
- (id<GSMessageWaitingIndicationService>) messageWaitingIndicationService |
- (void) removeConnection: | (id< GSConnection >) | connection |
Removes (and disables) the specified connection.
connection | the connection to remove (note that the connection object must not be a copy). |
- (id<GSVideoService>) videoService |
|
readwritenonatomicassign |
Get/set the delegate responsible for notifications about Message Wainting Indication state.
Definition at line 120 of file GSConnectionManager.h.
|
readwritenonatomicassign |
When set, the object implementing the GSConnectionNotificationDelegate protocol will be notified of all connection state changes.
Definition at line 105 of file GSConnectionManager.h.
|
readwritenonatomicassign |
Get/set the policy which defines connection behavior.
Definition at line 110 of file GSConnectionManager.h.
|
readwritenonatomicassign |
Get/set the delegate responsible for notifications about Video Stream state.
Definition at line 130 of file GSConnectionManager.h.
|
readwritenonatomicassign |
Get/set the policy which defines video stream behavior.
Definition at line 135 of file GSConnectionManager.h.