Diffusion Apple API
6.8.1
Unified Client Library for iOS, tvOS and OS X / macOS
|
Support for creating value streams for primitive values including string and numeric types.
+ (PTDiffusionValueStream *) doubleFloatNumberTimeSeriesEventValueStreamWithDelegate: | (id< PTDiffusionNumberTimeSeriesEventValueStreamDelegate >) | delegate |
Creates a value stream capable of receiving double-precision floating point numeric time series events.
delegate | The object which will handle the incoming stream. A weak reference is maintained to this object by the returned stream. |
NSInvalidArgumentException | Raised if the delegate argument is nil . |
+ (PTDiffusionValueStream *) doubleFloatNumberValueStreamWithDelegate: | (id< PTDiffusionNumberValueStreamDelegate >) | delegate |
Creates a value stream capable of receiving double-precision floating point numbers (Eight-byte IEEE 754).
delegate | The object which will handle the incoming stream. A weak reference is maintained to this object by the returned stream. |
NSInvalidArgumentException | Raised if the delegate argument is nil . |
+ (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.
delegate | The object which will handle the incoming requests. A weak reference is maintained to this object by the returned handler. |
NSInvalidArgumentException | Raised if the delegate argument is nil . |
+ (PTDiffusionRequestStream *) doubleFloatRequestStreamWithDelegate: | (id< PTDiffusionNumberRequestStreamDelegate >) | delegate |
Creates a request stream capable of receiving double-precision floating point numeric requests.
delegate | The object which will handle the incoming requests. A weak reference is maintained to this object by the returned stream. |
NSInvalidArgumentException | Raised if the delegate argument is nil . |
+ (PTDiffusionSessionResponseStream *) doubleFloatSessionResponseStreamWithDelegate: | (id< PTDiffusionNumberSessionResponseStreamDelegate >) | delegate |
Creates a response stream capable of receiving double-precision floating point numeric responses from discrete sessions.
delegate | The object which will handle the incoming responses. A weak reference is maintained to this object by the returned stream. |
NSInvalidArgumentException | Raised if the delegate argument is nil . |
+ (PTDiffusionValueStream *) int64NumberTimeSeriesEventValueStreamWithDelegate: | (id< PTDiffusionNumberTimeSeriesEventValueStreamDelegate >) | delegate |
Creates a value stream capable of receiving 64-bit integer time series events.
delegate | The object which will handle the incoming stream. A weak reference is maintained to this object by the returned stream. |
NSInvalidArgumentException | Raised if the delegate argument is nil . |
+ (PTDiffusionValueStream *) int64NumberValueStreamWithDelegate: | (id< PTDiffusionNumberValueStreamDelegate >) | delegate |
Creates a value stream capable of receiving 64-bit integer values.
delegate | The object which will handle the incoming stream. A weak reference is maintained to this object by the returned stream. |
NSInvalidArgumentException | Raised if the delegate argument is nil . |
+ (PTDiffusionRequestHandler *) int64RequestHandlerWithDelegate: | (id< PTDiffusionNumberRequestDelegate >) | delegate |
Creates a request handler capable of receiving 64-bit integer requests for a handler registered at the server.
delegate | The object which will handle the incoming requests. A weak reference is maintained to this object by the returned handler. |
NSInvalidArgumentException | Raised if the delegate argument is nil . |
+ (PTDiffusionRequestStream *) int64RequestStreamWithDelegate: | (id< PTDiffusionNumberRequestStreamDelegate >) | delegate |
Creates a request stream capable of receiving 64-bit integer requests.
delegate | The object which will handle the incoming requests. A weak reference is maintained to this object by the returned stream. |
NSInvalidArgumentException | Raised if the delegate argument is nil . |
+ (PTDiffusionSessionResponseStream *) int64SessionResponseStreamWithDelegate: | (id< PTDiffusionNumberSessionResponseStreamDelegate >) | delegate |
Creates a response stream capable of receiving 64-bit integer responses from discrete sessions.
delegate | The object which will handle the incoming responses. A weak reference is maintained to this object by the returned stream. |
NSInvalidArgumentException | Raised if the delegate argument is nil . |
+ (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.
value | The value to send as the request. |
nil
on failure.+ (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.
number | The value to send as the request. This may be nil in order to create a 'null' request. |
error | Location to store a reason if this method returns nil to indicate failure. |
nil
on failure.+ (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.
number | The value to send as the request. This may be nil in order to create a 'null' request. |
error | Location to store a reason if this method returns nil to indicate failure. |
nil
on failure.+ (PTDiffusionRequest *) requestWithLongLong: | (long long) | value |
Creates a request that can be used to send the given 64-bit integer value using messaging.
value | The value to send as the request. |
nil
on failure.+ (nullable PTDiffusionRequest *) requestWithString: | (nullable NSString *) | string | |
error: | (NSError **) | error | |
Creates a request that can be used to send the given string using messaging.
string | The value to send as the request. This may be nil in order to create a 'null' request. |
error | Location to store a reason if this method returns nil to indicate failure. |
nil
on failure.+ (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.
value | The value to send as the response. |
nil
on failure.+ (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.
number | The value to send as the response. This may be nil in order to create a 'null' response. |
error | Location to store a reason if this method returns nil to indicate failure. |
nil
on failure.+ (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.
number | The value to send as the response. This may be nil in order to create a 'null' response. |
error | Location to store a reason if this method returns nil to indicate failure. |
nil
on failure.+ (PTDiffusionResponse *) responseWithLongLong: | (long long) | value |
Creates a response that can be used to send the given 64-bit integer value using messaging.
value | The value to send as the response. |
nil
on failure.+ (nullable PTDiffusionResponse *) responseWithString: | (nullable NSString *) | string | |
error: | (NSError **) | error | |
Creates a response that can be used to send the given string using messaging.
string | The value to send as the response. This may be nil in order to create a 'null' response. |
error | Location to store a reason if this method returns nil to indicate failure. |
nil
on failure.+ (PTDiffusionRequestHandler *) stringRequestHandlerWithDelegate: | (id< PTDiffusionStringRequestDelegate >) | delegate |
Creates a request handler capable of receiving string requests for a handler registered at the server.
delegate | The object which will handle the incoming requests. A weak reference is maintained to this object by the returned handler. |
NSInvalidArgumentException | Raised if the delegate argument is nil . |
+ (PTDiffusionRequestStream *) stringRequestStreamWithDelegate: | (id< PTDiffusionStringRequestStreamDelegate >) | delegate |
Creates a request stream capable of receiving string requests.
delegate | The object which will handle the incoming requests. A weak reference is maintained to this object by the returned stream. |
NSInvalidArgumentException | Raised if the delegate argument is nil . |
+ (PTDiffusionSessionResponseStream *) stringSessionResponseStreamWithDelegate: | (id< PTDiffusionStringSessionResponseStreamDelegate >) | delegate |
Creates a response stream capable of receiving string responses from discrete sessions.
delegate | The object which will handle the incoming responses. A weak reference is maintained to this object by the returned stream. |
NSInvalidArgumentException | Raised if the delegate argument is nil . |
+ (PTDiffusionValueStream *) stringTimeSeriesEventValueStreamWithDelegate: | (id< PTDiffusionStringTimeSeriesEventValueStreamDelegate >) | delegate |
Creates a value stream capable of receiving string time series events.
delegate | The object which will handle the incoming stream. A weak reference is maintained to this object by the returned stream. |
NSInvalidArgumentException | Raised if the delegate argument is nil . |
+ (PTDiffusionValueStream *) stringValueStreamWithDelegate: | (id< PTDiffusionStringValueStreamDelegate >) | delegate |
Creates a value stream capable of receiving string values.
delegate | The object which will handle the incoming stream. A weak reference is maintained to this object by the returned stream. |
NSInvalidArgumentException | Raised if the delegate argument is nil . |
+ (PTDiffusionUpdateConstraint *) updateConstraintWithDouble: | (double) | value |
Returns an update constraint requiring the current value of a topic to match the given double-precision floating point (Eight-byte IEEE 754) value.
Use noValue (PTDiffusionUpdateConstraint) to check if the topic has no value.
This constraint is useful when changing the value of a topic. It is unsatisfied if no topic is present at the path, making it unsuitable for operations that try to add topics.
value | The value to be matched against the topic value. |
nil
on failure.+ (nullable PTDiffusionUpdateConstraint *) updateConstraintWithDoubleFloatNumber: | (NSNumber *) | number | |
error: | (NSError **) | error | |
Returns an update constraint requiring the current value of a topic to match the given double-precision floating point (Eight-byte IEEE 754) value.
Use noValue (PTDiffusionUpdateConstraint) to check if the topic has no value.
This constraint is useful when changing the value of a topic. It is unsatisfied if no topic is present at the path, making it unsuitable for operations that try to add topics.
number | The value to be matched against the topic value. |
error | Location to store a reason if this method returns nil to indicate failure. |
nil
on failure.NSInvalidArgumentException | If the number argument is nil . |
+ (nullable PTDiffusionUpdateConstraint *) updateConstraintWithInt64Number: | (NSString *) | number | |
error: | (NSError **) | error | |
Returns an update constraint requiring the current value of a topic to match the given 64-bit integer value.
Use noValue (PTDiffusionUpdateConstraint) to check if the topic has no value.
This constraint is useful when changing the value of a topic. It is unsatisfied if no topic is present at the path, making it unsuitable for operations that try to add topics.
number | The value to be matched against the topic value. |
error | Location to store a reason if this method returns nil to indicate failure. |
nil
on failure.NSInvalidArgumentException | If the number argument is nil . |
+ (PTDiffusionUpdateConstraint *) updateConstraintWithLongLong: | (long long) | value |
Returns an update constraint requiring the current value of a topic to match the given 64-bit integer value.
Use noValue (PTDiffusionUpdateConstraint) to check if the topic has no value.
This constraint is useful when changing the value of a topic. It is unsatisfied if no topic is present at the path, making it unsuitable for operations that try to add topics.
value | The value to be matched against the topic value. |
nil
on failure.+ (nullable PTDiffusionUpdateConstraint *) updateConstraintWithString: | (NSString *) | string | |
error: | (NSError **) | error | |
Returns an update constraint requiring the current value of a topic to match the given string value.
Use noValue (PTDiffusionUpdateConstraint) to check if the topic has no value.
This constraint is useful when changing the value of a topic. It is unsatisfied if no topic is present at the path, making it unsuitable for operations that try to add topics.
string | The value to be matched against the topic value. |
error | Location to store a reason if this method returns nil to indicate failure. |
nil
on failure.NSInvalidArgumentException | If the number argument is nil . |