SIP Endpoint SDK for OS X
 All Classes Functions Properties
<GSConnectionManager> Protocol Reference

#import <GSConnectionManager.h>

Inheritance diagram for <GSConnectionManager>:
GSSipConnectionManager

List of all members.

Public Member Functions

(id< GSConnection >) - addConnectionWithConfiguration:
(GSMwiSubscription *) - addSubscriptionWithConfiguration:
(id< GSConnection >) - addConnectionByConfigId:
(GSMwiSubscription *) - addSubscriptionByConfigId:
(int) - connectionIdByConfigId:
(id< GSConnection >) - connectionByConnectionId:
(id< GSConnection >) - connectionByConfigId:
(GSMwiSubscription *) - subscriptionByConfigId:
(GSMwiSubscription *) - subscriptionByMailboxId:
(void) - removeConnection:
(NSArray *) - allConnections
(NSArray *) - allSubscriptions
(id< GSMwiService >) - mwiService
(id< GSVideoService >) - videoService

Properties

id
< GSConnectionNotificationDelegate
notificationDelegate
id< GSMwiNotificationDelegatemwiNotificationDelegate

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 19 of file GSConnectionManager.h.


Member Function Documentation

- (id<GSConnection>) addConnectionByConfigId: (int)  configId

Adds a new connection by configuration ID

Parameters:
conifgIdrepresents sequential number of Connectivity in Basic container of the configuration file starting from 0
Returns:
a newly created connection object or nil if the operation is not successful.
- (id<GSConnection>) addConnectionWithConfiguration: (NSDictionary *)  configuration

Adds a new connection with complete set of configuration settings

Returns:
a newly created connection object or nil if the operation is not successful.
- (GSMwiSubscription*) addSubscriptionByConfigId: (int)  configId

Adds a new subscription by configuration ID

Parameters:
conifgIdrepresents sequential number of Connectivity in Basic container of the configuration file starting from 0
Returns:
a newly created subscription object or nil if the operation is not successful.
- (GSMwiSubscription*) addSubscriptionWithConfiguration: (NSDictionary *)  configuration

Adds a new subscription with complete set of configuration settings

Returns:
a newly created subscription 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
- (id<GSConnection>) connectionByConfigId: (int)  configId

Gets a connection by configuration ID

Parameters:
conifgIdrepresents sequential number of Connectivity in Basic container of the configuration file starting from 0
Returns:
a connection object of the registered connection
- (id<GSConnection>) connectionByConnectionId: (int)  connectionId

Gets a connection by connection ID

Parameters:
connectionIdrepresents connection ID of the registered connection
Returns:
a connection object of the registered connection
- (int) connectionIdByConfigId: (int)  configId

Gets a connection ID for registered connection by configuration ID

Parameters:
conifgIdrepresents sequential number of Connectivity in Basic container of the configuration file starting from 0
Returns:
a connection ID of the registered
- (id<GSMwiService>) mwiService
Returns:
an instance of the Message Waiting Indication service to be used for first party call control
- (void) removeConnection: (id< GSConnection >)  connection

Removes by unregistering the specified connection.

Parameters:
connectionthe connection to remove.
- (GSMwiSubscription*) subscriptionByConfigId: (int)  configId

Gets a subscription by configuration ID

Parameters:
conifgIdrepresents sequential number of Subscriptions in proxies domain of the configuration file starting from 0
Returns:
a subscription object with match configId
- (GSMwiSubscription*) subscriptionByMailboxId: (int)  mailboxId

Gets a subscription by mailbox ID

Parameters:
mailboxID represents sequential number of subscribed Subscriptions
Returns:
a subscription object with match mailboxId
- (id<GSVideoService>) videoService
Returns:
an instance of the Video service to be used for first party call control

Property Documentation

- (id<GSMwiNotificationDelegate>) mwiNotificationDelegate
readwritenonatomicretain

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

See also:
GSMwiNotificationDelegate

Definition at line 140 of file GSConnectionManager.h.

- (id<GSConnectionNotificationDelegate>) notificationDelegate
readwritenonatomicretain

Get/Set the object that implements the GSConnectionNotificationDelegate protocol will be notified of all connection state changes.

See also:
GSConnectionNotificationDelegate

Definition at line 128 of file GSConnectionManager.h.


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