Sip Endpoint SDK for Apple OS
 All Classes Functions Properties
<GSConnectionManager> Protocol Reference

#import <GSConnectionManager.h>

List of all members.

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

Properties

int endpointId
id
< GSConnectionNotificationDelegate
notificationDelegate
id< GSConnectionPolicyDelegatepolicyDelegate
id
< GSMessageWaitingIndicationNotificationDelegate
messageWaitingIndicationNotificationDelegate
id
< GSVideoStreamNotificationDelegate
videoStreamNotificationDelegate
id< GSVideoStreamPolicyDelegatevideoStreamPolicyDelegate

Detailed Description

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.


Member Function Documentation

- (id<GSConnection>) addConnectionForUser: (NSString *)  user
server: (NSString *)  server
transport: (NSString *)  transport 

Adds a new connection

Parameters:
userthe user id
serverthe server address
transportthe transport protocol (valid values are 'tcp' or 'udp')
Returns:
a newly created connection object or nil if the operation is not successful.
- (NSArray*) allConnections
Returns:
a snapshot of current connections
- (NSArray*) allSubscriptions
Returns:
a snapshot of current subscriptions
- (NSArray*) connectionsForUser: (NSString *)  user
toServer: (NSString *)  server 

Utility method to retrieve a snapshot of current connections for the specified user id and server.

Parameters:
userthe user id for the connection
serverthe server address
Returns:
a list of all connections matching the specified criteria
- (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.

Parameters:
userthe user id for the connection
serverthe server address
transportthe transport protocol
Returns:
a list of all connections matching the specified criteria
- (NSArray*) connectionsToServer: (NSString *)  server

Utility method to retrieve a snapshot of current connections to the specified server.

Parameters:
serverthe server address
Returns:
a list of all connections to the specified server
- (NSArray*) connectionsToServer: (NSString *)  server
withTransport: (NSString *)  transport 

Utility method to retrieve a snapshot of current connections with the specified transport to the given server.

Parameters:
serverthe server address
transportthe transport protocol
Returns:
a list of all connections matching the specified criteria
- (id<GSMessageWaitingIndicationService>) messageWaitingIndicationService
Returns:
an instance of the Message Waiting Indication service to be used for first party call control
- (void) removeConnection: (id< GSConnection >)  connection

Removes (and disables) the specified connection.

Parameters:
connectionthe connection to remove (note that the connection object must not be a copy).
- (id<GSVideoService>) videoService
Returns:
an instance of the Video service to be used for first party call control

Property Documentation

- (id<GSMessageWaitingIndicationNotificationDelegate>) messageWaitingIndicationNotificationDelegate
readwritenonatomicassign

Get/set the delegate responsible for notifications about Message Wainting Indication state.

Definition at line 120 of file GSConnectionManager.h.

- (id<GSConnectionNotificationDelegate>) notificationDelegate
readwritenonatomicassign

When set, the object implementing the GSConnectionNotificationDelegate protocol will be notified of all connection state changes.

See also:
GSConnectionNotificationDelegate

Definition at line 105 of file GSConnectionManager.h.

- (id<GSConnectionPolicyDelegate>) policyDelegate
readwritenonatomicassign

Get/set the policy which defines connection behavior.

Definition at line 110 of file GSConnectionManager.h.

- (id<GSVideoStreamNotificationDelegate>) videoStreamNotificationDelegate
readwritenonatomicassign

Get/set the delegate responsible for notifications about Video Stream state.

Definition at line 130 of file GSConnectionManager.h.

- (id<GSVideoStreamPolicyDelegate>) videoStreamPolicyDelegate
readwritenonatomicassign

Get/set the policy which defines video stream behavior.

Definition at line 135 of file GSConnectionManager.h.


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