Introduction

A session represents a single connection to a single Diffusion server.

The Quick Start guide provides basic instructions on how to get connected to a Diffusion server.

See Also: PTDiffusionSessionStateChange

Since: 5.6

Inheritance diagram for PTDiffusionSession:

Class Methods
(void)	+ openWithURL:configuration:completionHandler:

(void)	+ openWithURL:completionHandler:

Properties
PTDiffusionSessionConfiguration *	configuration

PTDiffusionSessionId *	sessionId

PTDiffusionSessionState *	state

PTDiffusionTopicsFeature *	topics

PTDiffusionTopicControlFeature *	topicControl

PTDiffusionTopicUpdateControlFeature *	topicUpdateControl

PTDiffusionMessagingFeature *	messaging

PTDiffusionSecurityFeature *	security

PTDiffusionPingsFeature *	pings

Instance Methods
(void)	- close

Method Documentation

- (void) close

Close the session. Once closed a session cannot be restarted.

Since: 5.6

+ (void) openWithURL:	(NSURL *)	url
completionHandler:	(PTDiffusionSession *_Nullable)	session
	(NSError *_Nullable error)	completionHandler

Starts asynchronously connecting to a Diffusion server using the default session configuration.

Parameters

url	The location of the server to connect to. Encapsulates host, port and protocol to use. Must be absolute.
completionHandler	The completion handler to call on connection success or failure. The completion handler will be called from the main dispatch queue and will only be called once.

Note: Your completion handler must store a strong reference to the session instance in order for it to remain open.; The completion handler block is called after the session's state property has been set to connected but before those observing via the notification center are informed.

Since: 5.6

+ (void) openWithURL:	(NSURL *)	url
configuration:	(PTDiffusionSessionConfiguration *)	configuration
completionHandler:	(PTDiffusionSession *_Nullable)	session
	(NSError *_Nullable error)	completionHandler

Starts asynchronously connecting to a Diffusion server using the given session configuration.

Parameters

url	The location of the server to connect to. Encapsulates host, port and protocol to use. Must be absolute.
configuration	The configuration options to connect with.
completionHandler	The completion handler to call on connection success or failure. The completion handler will be called from the main dispatch queue and will only be called once.

Note: Your completion handler must store a strong reference to the session instance in order for it to remain open.; The completion handler block is called after the session's state property has been set to connected but before those observing via the notification center are informed.

Since: 5.6

Property Documentation

- (PTDiffusionSessionConfiguration*) configuration

readnonatomiccopy

The configuration used to open the session.

Since: 5.6

- (PTDiffusionMessagingFeature*) messaging

readnonatomicassign

The Messaging feature provides messaging capabilities.

Since: 5.6

- (PTDiffusionPingsFeature*) pings

readnonatomicassign

The Pings feature provides a client session with the ability to test the roundtrip time associated with sending a request to the server and receiving the associated response.

Since: 5.7

- (PTDiffusionSecurityFeature*) security

readnonatomicassign

The Security feature provides a client session with the ability to change the associated principal.

Since: 5.6

- (PTDiffusionSessionId*) sessionId

readnonatomicassign

The unique identifier for the session as assigned by the server it connects to.

This property is Key-Value Observable with changes being notified on the main dispatch queue.

- (PTDiffusionSessionState*) state

readnonatomicassign

The current state of the session.

This property is Key-Value Observable with changes being notified on the main dispatch queue. KVO notifications are sent before the invocation of any callback handler blocks.