Diffusion Apple API  6.2.0
Unified Client Library for iOS, tvOS and OS X / macOS
 All Classes Functions Variables Properties Pages
Class Methods | Instance Methods | List of all members
PTDiffusionPrimitive Class Reference

Introduction

Support for creating value streams for primitive values including string and numeric types.

Since
6.0
Inheritance diagram for PTDiffusionPrimitive:

Class Methods

(instancetype) + NS_UNAVAILABLE
 
(PTDiffusionValueStream *) + doubleFloatNumberValueStreamWithDelegate:
 
(PTDiffusionValueStream *) + int64NumberValueStreamWithDelegate:
 
(PTDiffusionValueStream *) + stringValueStreamWithDelegate:
 
(PTDiffusionValueStream *) + doubleFloatNumberTimeSeriesEventValueStreamWithDelegate:
 
(PTDiffusionValueStream *) + int64NumberTimeSeriesEventValueStreamWithDelegate:
 
(PTDiffusionValueStream *) + stringTimeSeriesEventValueStreamWithDelegate:
 
(PTDiffusionRequestHandler *) + doubleFloatRequestHandlerWithDelegate:
 
(PTDiffusionRequestHandler *) + int64RequestHandlerWithDelegate:
 
(PTDiffusionRequestHandler *) + stringRequestHandlerWithDelegate:
 
(PTDiffusionRequestStream *) + doubleFloatRequestStreamWithDelegate:
 
(PTDiffusionRequestStream *) + int64RequestStreamWithDelegate:
 
(PTDiffusionRequestStream *) + stringRequestStreamWithDelegate:
 
(PTDiffusionSessionResponseStream *) + doubleFloatSessionResponseStreamWithDelegate:
 
(PTDiffusionSessionResponseStream *) + int64SessionResponseStreamWithDelegate:
 
(PTDiffusionSessionResponseStream *) + stringSessionResponseStreamWithDelegate:
 
(PTDiffusionRequest *) + requestWithDouble:
 
(nullable PTDiffusionRequest *) + requestWithDoubleFloatNumber:error:
 
(PTDiffusionRequest *) + requestWithLongLong:
 
(nullable PTDiffusionRequest *) + requestWithInt64Number:error:
 
(nullable PTDiffusionRequest *) + requestWithString:error:
 
(PTDiffusionResponse *) + responseWithDouble:
 
(nullable PTDiffusionResponse *) + responseWithDoubleFloatNumber:error:
 
(PTDiffusionResponse *) + responseWithLongLong:
 
(nullable PTDiffusionResponse *) + responseWithInt64Number:error:
 
(nullable PTDiffusionResponse *) + responseWithString:error:
 

Instance Methods

(instancetype) - NS_UNAVAILABLE
 

Method Documentation

+ (PTDiffusionValueStream *) doubleFloatNumberTimeSeriesEventValueStreamWithDelegate: (id< PTDiffusionNumberTimeSeriesEventValueStreamDelegate >)  delegate

Creates a value stream capable of receiving double-precision floating point numeric time series events.

Parameters
delegateThe object which will handle the incoming stream. A weak reference is maintained to this object by the returned stream.
Returns
An object reliant on the supplied delegate that can be added as a receiver of values using the Topics feature.
Exceptions
NSInvalidArgumentExceptionRaised if the delegate argument is nil.
See Also
PTDiffusionTopicsFeature
Since
6.0
+ (PTDiffusionValueStream *) doubleFloatNumberValueStreamWithDelegate: (id< PTDiffusionNumberValueStreamDelegate >)  delegate

Creates a value stream capable of receiving double-precision floating point numbers (Eight-byte IEEE 754).

Parameters
delegateThe object which will handle the incoming stream. A weak reference is maintained to this object by the returned stream.
Returns
An object reliant on the supplied delegate that can be added as a receiver of values using the Topics feature.
Exceptions
NSInvalidArgumentExceptionRaised if the delegate argument is nil.
See Also
PTDiffusionTopicsFeature
Since
6.0
+ (PTDiffusionRequestHandler *) doubleFloatRequestHandlerWithDelegate: (id< PTDiffusionNumberRequestDelegate >)  delegate

Creates a request handler capable of receiving double-precision floating point numeric requests (Eight-byte IEEE 754) for a handler registered at the server.

Parameters
delegateThe object which will handle the incoming requests. A weak reference is maintained to this object by the returned handler.
Returns
An object reliant on the supplied delegate that can be registered at the server using the Messaging Control feature.
Exceptions
NSInvalidArgumentExceptionRaised if the delegate argument is nil.
See Also
PTDiffusionMessagingControlFeature
Since
6.0
+ (PTDiffusionRequestStream *) doubleFloatRequestStreamWithDelegate: (id< PTDiffusionNumberRequestStreamDelegate >)  delegate

Creates a request stream capable of receiving double-precision floating point numeric requests.

Parameters
delegateThe object which will handle the incoming requests. A weak reference is maintained to this object by the returned stream.
Returns
An object reliant on the supplied delegate that can be set as the receiver of requests using the Messaging feature.
Exceptions
NSInvalidArgumentExceptionRaised if the delegate argument is nil.
See Also
PTDiffusionMessagingFeature
Since
6.0
+ (PTDiffusionSessionResponseStream *) doubleFloatSessionResponseStreamWithDelegate: (id< PTDiffusionNumberSessionResponseStreamDelegate >)  delegate

Creates a response stream capable of receiving double-precision floating point numeric responses from discrete sessions.

Parameters
delegateThe object which will handle the incoming responses. A weak reference is maintained to this object by the returned stream.
Returns
An object reliant on the supplied delegate that can be set as the receiver of requests using the Messaging Control feature.
Exceptions
NSInvalidArgumentExceptionRaised if the delegate argument is nil.
See Also
PTDiffusionMessagingControlFeature
Since
6.1
+ (PTDiffusionValueStream *) int64NumberTimeSeriesEventValueStreamWithDelegate: (id< PTDiffusionNumberTimeSeriesEventValueStreamDelegate >)  delegate

Creates a value stream capable of receiving 64-bit integer time series events.

Parameters
delegateThe object which will handle the incoming stream. A weak reference is maintained to this object by the returned stream.
Returns
An object reliant on the supplied delegate that can be added as a receiver of values using the Topics feature.
Exceptions
NSInvalidArgumentExceptionRaised if the delegate argument is nil.
See Also
PTDiffusionTopicsFeature
Since
6.0
+ (PTDiffusionValueStream *) int64NumberValueStreamWithDelegate: (id< PTDiffusionNumberValueStreamDelegate >)  delegate

Creates a value stream capable of receiving 64-bit integer values.

Parameters
delegateThe object which will handle the incoming stream. A weak reference is maintained to this object by the returned stream.
Returns
An object reliant on the supplied delegate that can be added as a receiver of values using the Topics feature.
Exceptions
NSInvalidArgumentExceptionRaised if the delegate argument is nil.
See Also
PTDiffusionTopicsFeature
Since
6.0
+ (PTDiffusionRequestHandler *) int64RequestHandlerWithDelegate: (id< PTDiffusionNumberRequestDelegate >)  delegate

Creates a request handler capable of receiving 64-bit integer requests for a handler registered at the server.

Parameters
delegateThe object which will handle the incoming requests. A weak reference is maintained to this object by the returned handler.
Returns
An object reliant on the supplied delegate that can be registered at the server using the Messaging Control feature.
Exceptions
NSInvalidArgumentExceptionRaised if the delegate argument is nil.
See Also
PTDiffusionMessagingControlFeature
Since
6.0
+ (PTDiffusionRequestStream *) int64RequestStreamWithDelegate: (id< PTDiffusionNumberRequestStreamDelegate >)  delegate

Creates a request stream capable of receiving 64-bit integer requests.

Parameters
delegateThe object which will handle the incoming requests. A weak reference is maintained to this object by the returned stream.
Returns
An object reliant on the supplied delegate that can be set as the receiver of requests using the Messaging feature.
Exceptions
NSInvalidArgumentExceptionRaised if the delegate argument is nil.
See Also
PTDiffusionMessagingFeature
Since
6.0
+ (PTDiffusionSessionResponseStream *) int64SessionResponseStreamWithDelegate: (id< PTDiffusionNumberSessionResponseStreamDelegate >)  delegate

Creates a response stream capable of receiving 64-bit integer responses from discrete sessions.

Parameters
delegateThe object which will handle the incoming responses. A weak reference is maintained to this object by the returned stream.
Returns
An object reliant on the supplied delegate that can be set as the receiver of requests using the Messaging Control feature.
Exceptions
NSInvalidArgumentExceptionRaised if the delegate argument is nil.
See Also
PTDiffusionMessagingControlFeature
Since
6.1
+ (PTDiffusionRequest *) requestWithDouble: (double)  value

Creates a request that can be used to send the given double-precision floating point (Eight-byte IEEE 754) value using messaging.

Parameters
valueThe value to send as the request.
See Also
PTDiffusionMessagingFeature
PTDiffusionMessagingControlFeature
Since
6.0
+ (nullable PTDiffusionRequest *) requestWithDoubleFloatNumber: (nullable NSNumber *)  number
error: (NSError **)  error 

Creates a request that can be used to send the given double-precision floating point (Eight-byte IEEE 754) value using messaging.

Parameters
numberThe value to send as the request. This may be nil in order to create a 'null' request.
errorLocation to store a reason if this method returns nil to indicate failure.
Returns
The new request, or nil on failure.
See Also
PTDiffusionMessagingFeature
PTDiffusionMessagingControlFeature
Since
6.0
+ (nullable PTDiffusionRequest *) requestWithInt64Number: (nullable NSNumber *)  number
error: (NSError **)  error 

Creates a request that can be used to send the given 64-bit integer value using messaging.

Parameters
numberThe value to send as the request. This may be nil in order to create a 'null' request.
errorLocation to store a reason if this method returns nil to indicate failure.
Returns
The new request, or nil on failure.
See Also
PTDiffusionMessagingFeature
PTDiffusionMessagingControlFeature
Since
6.0
+ (PTDiffusionRequest *) requestWithLongLong: (long long)  value

Creates a request that can be used to send the given 64-bit integer value using messaging.

Parameters
valueThe value to send as the request.
See Also
PTDiffusionMessagingFeature
PTDiffusionMessagingControlFeature
Since
6.0
+ (nullable PTDiffusionRequest *) requestWithString: (nullable NSString *)  string
error: (NSError **)  error 

Creates a request that can be used to send the given string using messaging.

Parameters
stringThe value to send as the request. This may be nil in order to create a 'null' request.
errorLocation to store a reason if this method returns nil to indicate failure.
Returns
The new request, or nil on failure.
See Also
PTDiffusionMessagingFeature
PTDiffusionMessagingControlFeature
Since
6.0
+ (PTDiffusionResponse *) responseWithDouble: (double)  value

Creates a response that can be used to send the given double-precision floating point (Eight-byte IEEE 754) value using messaging.

Parameters
valueThe value to send as the response.
See Also
PTDiffusionMessagingFeature
PTDiffusionMessagingControlFeature
Since
6.1
+ (nullable PTDiffusionResponse *) responseWithDoubleFloatNumber: (nullable NSNumber *)  number
error: (NSError **)  error 

Creates a response that can be used to send the given double-precision floating point (Eight-byte IEEE 754) value using messaging.

Parameters
numberThe value to send as the response. This may be nil in order to create a 'null' response.
errorLocation to store a reason if this method returns nil to indicate failure.
Returns
The new response, or nil on failure.
See Also
PTDiffusionMessagingFeature
PTDiffusionMessagingControlFeature
Since
6.1
+ (nullable PTDiffusionResponse *) responseWithInt64Number: (nullable NSNumber *)  number
error: (NSError **)  error 

Creates a response that can be used to send the given 64-bit integer value using messaging.

Parameters
numberThe value to send as the response. This may be nil in order to create a 'null' response.
errorLocation to store a reason if this method returns nil to indicate failure.
Returns
The new response, or nil on failure.
See Also
PTDiffusionMessagingFeature
PTDiffusionMessagingControlFeature
Since
6.1
+ (PTDiffusionResponse *) responseWithLongLong: (long long)  value

Creates a response that can be used to send the given 64-bit integer value using messaging.

Parameters
valueThe value to send as the response.
See Also
PTDiffusionMessagingFeature
PTDiffusionMessagingControlFeature
Since
6.1
+ (nullable PTDiffusionResponse *) responseWithString: (nullable NSString *)  string
error: (NSError **)  error 

Creates a response that can be used to send the given string using messaging.

Parameters
stringThe value to send as the response. This may be nil in order to create a 'null' response.
errorLocation to store a reason if this method returns nil to indicate failure.
Returns
The new response, or nil on failure.
See Also
PTDiffusionMessagingFeature
PTDiffusionMessagingControlFeature
Since
6.1
+ (PTDiffusionRequestHandler *) stringRequestHandlerWithDelegate: (id< PTDiffusionStringRequestDelegate >)  delegate

Creates a request handler capable of receiving string requests for a handler registered at the server.

Parameters
delegateThe object which will handle the incoming requests. A weak reference is maintained to this object by the returned handler.
Returns
An object reliant on the supplied delegate that can be registered at the server using the Messaging Control feature.
Exceptions
NSInvalidArgumentExceptionRaised if the delegate argument is nil.
See Also
PTDiffusionMessagingControlFeature
Since
6.0
+ (PTDiffusionRequestStream *) stringRequestStreamWithDelegate: (id< PTDiffusionStringRequestStreamDelegate >)  delegate

Creates a request stream capable of receiving string requests.

Parameters
delegateThe object which will handle the incoming requests. A weak reference is maintained to this object by the returned stream.
Returns
An object reliant on the supplied delegate that can be set as the receiver of requests using the Messaging feature.
Exceptions
NSInvalidArgumentExceptionRaised if the delegate argument is nil.
See Also
PTDiffusionMessagingFeature
Since
6.0
+ (PTDiffusionSessionResponseStream *) stringSessionResponseStreamWithDelegate: (id< PTDiffusionStringSessionResponseStreamDelegate >)  delegate

Creates a response stream capable of receiving string responses from discrete sessions.

Parameters
delegateThe object which will handle the incoming responses. A weak reference is maintained to this object by the returned stream.
Returns
An object reliant on the supplied delegate that can be set as the receiver of requests using the Messaging Control feature.
Exceptions
NSInvalidArgumentExceptionRaised if the delegate argument is nil.
See Also
PTDiffusionMessagingControlFeature
Since
6.1
+ (PTDiffusionValueStream *) stringTimeSeriesEventValueStreamWithDelegate: (id< PTDiffusionStringTimeSeriesEventValueStreamDelegate >)  delegate

Creates a value stream capable of receiving string time series events.

Parameters
delegateThe object which will handle the incoming stream. A weak reference is maintained to this object by the returned stream.
Returns
An object reliant on the supplied delegate that can be added as a receiver of values using the Topics feature.
Exceptions
NSInvalidArgumentExceptionRaised if the delegate argument is nil.
See Also
PTDiffusionTopicsFeature
Since
6.0
+ (PTDiffusionValueStream *) stringValueStreamWithDelegate: (id< PTDiffusionStringValueStreamDelegate >)  delegate

Creates a value stream capable of receiving string values.

Parameters
delegateThe object which will handle the incoming stream. A weak reference is maintained to this object by the returned stream.
Returns
An object reliant on the supplied delegate that can be added as a receiver of values using the Topics feature.
Exceptions
NSInvalidArgumentExceptionRaised if the delegate argument is nil.
See Also
PTDiffusionTopicsFeature
Since
6.0