PTDiffusionResponder Class Reference

Introduction

Responder provided with requests, used to dispatch responses.

See also

PTDiffusionRequestHandler

PTDiffusionBinary

PTDiffusionJSON

PTDiffusionPrimitive

PTDiffusionRecordV2

Since

6.0

Inheritance diagram for PTDiffusionResponder:

Instance Methods
(void)	- respondWithResponse:
(void)	- rejectWithReason:
(void)	- respondWithBinary:
(void)	- respondWithJSON:
(void)	- respondWithDouble:
(BOOL)	- respondWithDoubleFloatNumber:error:
(void)	- respondWithLongLong:
(BOOL)	- respondWithInt64Number:error:
(BOOL)	- respondWithString:error:
(void)	- respondWithRecord:

Method Documentation

rejectWithReason:

- (void) rejectWithReason:

(NSString *)

reason

Dispatch a rejection to a request, indicating that a response could not be generated.

Parameters

reason

Freeform text to provide to the requestor by way of explanation for this rejection.

Exceptions

NSInvalidArgumentException

Raised if the reason argument is `nil`.

Since

6.0

respondWithBinary:

- (void) respondWithBinary:

(PTDiffusionBinary *)

binary

Dispatch a response to a request.

Parameters

binary

The value to send in response.

Exceptions

NSInvalidArgumentException

Raised if the binary argument is `nil`.

Since

6.0

Provided by category PTDiffusionResponder(PTDiffusionBinary).

respondWithDouble:

- (void) respondWithDouble:

(double)

value

Dispatch a double-precision floating point (Eight-byte IEEE 754) response to a request.

Parameters

value

The value to send in response.

Since

6.0

Provided by category PTDiffusionResponder(PTDiffusionPrimitive).

respondWithDoubleFloatNumber:error:

- (BOOL) respondWithDoubleFloatNumber:		(nullable NSNumber *)	number
error:		(NSError **)	error

Dispatch a double-precision floating point (Eight-byte IEEE 754) response to a request.

Parameters

number	The value to send in response. This may be nil in order to send a 'null' response.
error	Location to store a reason if this method returns NO to indicate failure.

Returns

YES if a response was queued for dispatch or NO if the supplied number could not be encoded using this data type.

Since

6.0

Provided by category PTDiffusionResponder(PTDiffusionPrimitive).

respondWithInt64Number:error:

- (BOOL) respondWithInt64Number:		(nullable NSNumber *)	number
error:		(NSError **)	error

Dispatch a 64-bit integer response to a request.

Parameters

number	The value to send in response. This may be nil in order to send a 'null' response.
error	Location to store a reason if this method returns NO to indicate failure.

Returns

YES if a response was queued for dispatch or NO if the supplied number could not be encoded using this data type.

Since

6.0

Provided by category PTDiffusionResponder(PTDiffusionPrimitive).

respondWithJSON:

- (void) respondWithJSON:

(PTDiffusionJSON *)

json

Dispatch a response to a request.

Parameters

json	The value to send in response.

Exceptions

NSInvalidArgumentException

Raised if the json argument is `nil`.

Since

6.0

Provided by category PTDiffusionResponder(PTDiffusionJSON).

respondWithLongLong:

- (void) respondWithLongLong:

(long long)

value

Dispatch a 64-bit integer response to a request.

Parameters

value

The value to send in response.

Since

6.0

Provided by category PTDiffusionResponder(PTDiffusionPrimitive).

respondWithRecord:

- (void) respondWithRecord:

(PTDiffusionRecordV2 *)

record

Dispatch a response to a request.

Parameters

record

The value to send in response.

Exceptions

NSInvalidArgumentException

Raised if the record argument is `nil`.

Since

6.0

Provided by category PTDiffusionResponder(PTDiffusionRecordV2).

respondWithResponse:

- (void) respondWithResponse:

(PTDiffusionResponse *)

response

Dispatch a response to a request.

Parameters

response

The value to send in response.

Exceptions

NSInvalidArgumentException

Raised if the response argument is `nil`.

Since

6.1

respondWithString:error:

- (BOOL) respondWithString:		(nullable NSString *)	string
error:		(NSError **)	error

Dispatch a string response to a request.

Parameters

string	The value to send in response. This may be nil in order to send a 'null' response.
error	Location to store a reason if this method returns NO to indicate failure.

Returns

YES if a response was queued for dispatch or NO if the supplied string could not be encoded using this data type.

Since

6.0

Provided by category PTDiffusionResponder(PTDiffusionPrimitive).