PTDiffusionBinary Class Reference

Introduction

An immutable binary value with support for binary deltas.

Since

5.9

Inheritance diagram for PTDiffusionBinary:

Class Methods
(PTDiffusionValueStream *)	+ valueStreamWithDelegate:
(PTDiffusionValueStream *)	+ timeSeriesEventValueStreamWithDelegate:
(PTDiffusionRequestHandler *)	+ requestHandlerWithDelegate:
(PTDiffusionRequestStream *)	+ requestStreamWithDelegate:
(PTDiffusionSessionResponseStream *)	+ sessionResponseStreamWithDelegate:

Properties
PTDiffusionRequest *	request
PTDiffusionResponse *	response
PTDiffusionUpdateConstraint *	updateConstraint
Properties inherited from PTDiffusionBytes
NSData *	data

Instance Methods
(nullable PTDiffusionBinary *)	- applyDelta:error:
(PTDiffusionBinaryDelta *)	- diffFromBinary:
(BOOL)	- isEqualToBinary:
Instance Methods inherited from PTDiffusionBytes
(instancetype)	- initWithData:
(BOOL)	- isEqualToBytes:

Method Documentation

applyDelta:error:

- (nullable PTDiffusionBinary *) applyDelta:		(PTDiffusionBinaryDelta *)	delta
error:		(NSError **)	error

Apply a binary delta to the receiver's binary value to create a new value.

Parameters

delta	The delta describing the changes to be applied to the receiver's value in order to create the value to be returned.
error	Location to store a reason if this method returns nil to indicate failure.

Returns

The new binary value or nil if there was a failure when applying the delta (e.g. either the delta is invalid).

Exceptions

NSInvalidArgumentException

Raised if the delta argument is `nil`.

Since

5.9

diffFromBinary:

- (PTDiffusionBinaryDelta *) diffFromBinary:

(PTDiffusionBinary *)

binary

Compare the receiver's binary value with another (e.g. an earlier version) to create a binary delta.

Parameters

binary

The original to which the delta should be able to be applied in order to generate the value represented by the receiver.

Returns

A binary delta representing the difference between binary and the receiver.

Exceptions

NSInvalidArgumentException

Raised if the binary argument is `nil`.

Since

5.9

isEqualToBinary:

- (BOOL) isEqualToBinary:

(nullable PTDiffusionBinary *)

binary

Compares the receiver to the given binary.

Parameters

binary

The binary object with which to compare the receiver.

Returns

YES if the data in binary is equal to the contents of the receiver, otherwise NO.

Note

Two binary objects are equal if they hold the same number of data bytes, and if the bytes at the same position in the objects are the same.

Since

5.9

requestHandlerWithDelegate:

+ (PTDiffusionRequestHandler *) requestHandlerWithDelegate:

(id< PTDiffusionBinaryRequestDelegate >)

delegate

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

Parameters

delegate

The 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 feature.

Exceptions

NSInvalidArgumentException

Raised if the delegate argument is `nil`.

See also

PTDiffusionMessagingFeature

Since

6.0

requestStreamWithDelegate:

+ (PTDiffusionRequestStream *) requestStreamWithDelegate:

(id< PTDiffusionBinaryRequestStreamDelegate >)

delegate

Creates a request stream capable of receiving Binary requests.

Parameters

delegate

The 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

NSInvalidArgumentException

Raised if the delegate argument is `nil`.

See also

PTDiffusionMessagingFeature

Since

6.0

sessionResponseStreamWithDelegate:

+ (PTDiffusionSessionResponseStream *) sessionResponseStreamWithDelegate:

(id< PTDiffusionBinarySessionResponseStreamDelegate >)

delegate

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

Parameters

delegate

The 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 feature.

Exceptions

NSInvalidArgumentException

Raised if the delegate argument is `nil`.

See also

PTDiffusionMessagingFeature

Since

6.1

timeSeriesEventValueStreamWithDelegate:

+ (PTDiffusionValueStream *) timeSeriesEventValueStreamWithDelegate:

(id< PTDiffusionBinaryTimeSeriesEventValueStreamDelegate >)

delegate

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

Parameters

delegate

The 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

NSInvalidArgumentException

Raised if the delegate argument is `nil`.

See also

PTDiffusionTopicsFeature

Since

6.0

valueStreamWithDelegate:

+ (PTDiffusionValueStream *) valueStreamWithDelegate:

(id< PTDiffusionBinaryValueStreamDelegate >)

delegate

Creates a value stream capable of receiving binary values.

Parameters

delegate

The 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

NSInvalidArgumentException

Raised if the delegate argument is `nil`.

See also

PTDiffusionTopicsFeature

Since

5.9

Property Documentation

request

- (PTDiffusionRequest*) request

readnonatomicassign

A request that can be used to send this value using messaging.

Since

6.0

response

- (PTDiffusionResponse*) response

readnonatomicassign

A response that can be used to send this value using messaging.

Since

6.1

updateConstraint

- (PTDiffusionUpdateConstraint*) updateConstraint

readnonatomicassign

An update constraint requiring the current value of a topic to match this value.

Use noValue (PTDiffusionUpdateConstraint) to check if the topic has no value.

This constraint is unsatisfied if no topic is present at the path.

Since

6.3