R5Connection Class Reference

The main connection class for R5Pro. This establishes the connection to the server. Used by R5Stream as the communication layer. More...

#import <R5Connection.h>

Inherits NSObject.

Instance Methods
(id)	- initWithConfig:
(void)	- invalidate
(void)	- call:withReturn:withParam:
(void)	- connectToSharedObject:
(void)	- sharedObjectSend:
(void)	- switchStream:name:
(void)	- startDataOnlyStream
(void)	- stopDataOnlyStream
(client_ctx *)	- context

Properties
R5Configuration *	config
NSObject< R5ConnectionDelegate > *	delegate
NSObject *	client

Detailed Description

The main connection class for R5Pro. This establishes the connection to the server. Used by R5Stream as the communication layer.

Method Documentation

call:withReturn:withParam:

- (void) call:		(NSString *)	method
withReturn:		(NSString *)	returnMethod
withParam:		(NSString *)	param

Make a connection call RPC to the server

Parameters

method	Method name to call
returnMethod	Return method name. "void" if no return
param	Parameter to send for this method

context

- (client_ctx *) context

Get the connection context associated with this context

Returns

A client connection context.

initWithConfig:

- (id) initWithConfig:

(R5Configuration *)

configuration

Initialize the connection with the configuration

Parameters

config

The configuration of the connection

Returns

a new connection

invalidate

- (void) invalidate

De-initialize the connection.

startDataOnlyStream

- (void) startDataOnlyStream

Request a connection for data transfers - can't be used if this object is already being used for an A/V stream

switchStream:name:

- (void) switchStream:		(NSString *)	app
name:		(NSString *)	streamName

Request to switch the stream received on the current connection.

Parameters

app	The webapp context the target stream is being streamed in. e.g., "live".
streamName	The new target stream name to request playback.

Property Documentation

client

- (NSObject*) client

readwriteatomic

The client to receive rpc calls for this connection. Specifically for Data Only streams.

config

- (R5Configuration*) config

readatomicassign

The configuration for this connection

delegate

- (NSObject<R5ConnectionDelegate>*) delegate

readwriteatomic

The delegate to receive events for this connection. Specifically for Data Only streams.

---

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

• /Users/ankitashankhdhar/Documents/Red5/Git/infrared5/red5pro-core-streaming-library/red5streaming/src/R5Connection.h