PTDiffusionMessagingFeature(PTDiffusionPrimitive) Category Reference

Extension adding support to the Messaging feature for sending requests accepting a primitive value in response. More...

#include <PTDiffusionPrimitive.h>

Instance Methods
(void)	- sendRequest:toPath:stringCompletionHandler:
(void)	- sendRequest:toPath:doubleFloatNumberCompletionHandler:
(void)	- sendRequest:toPath:int64NumberCompletionHandler:
(void)	- sendRequest:toSessionId:path:stringCompletionHandler:
(void)	- sendRequest:toSessionId:path:doubleFloatNumberCompletionHandler:
(void)	- sendRequest:toSessionId:path:int64NumberCompletionHandler:

Detailed Description

Extension adding support to the Messaging feature for sending requests accepting a primitive value in response.

Since

6.0

Method Documentation

sendRequest:toPath:doubleFloatNumberCompletionHandler:

- (void) sendRequest:		(PTDiffusionRequest *)	request
toPath:		(NSString *)	path
doubleFloatNumberCompletionHandler:		(void(^)(NSNumber *_Nullable number, NSError *_Nullable error))	completionHandler

Send a request for which a double-precision floating point (Eight-byte IEEE 754) response is expected.

The message will be routed to an appropriately registered control handler for the given path.

Parameters

request	The request to send.
path	The path to send the request to.
completionHandler	Block to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.

Exceptions

NSInvalidArgumentException

Raised if any supplied arguments are `nil`.

Since

6.0

Extends class PTDiffusionMessagingFeature.

sendRequest:toPath:int64NumberCompletionHandler:

- (void) sendRequest:		(PTDiffusionRequest *)	request
toPath:		(NSString *)	path
int64NumberCompletionHandler:		(void(^)(NSNumber *_Nullable number, NSError *_Nullable error))	completionHandler

Send a request for which a 64-bit integer response is expected.

The message will be routed to an appropriately registered control handler for the given path.

Parameters

request	The request to send.
path	The path to send the request to.
completionHandler	Block to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.

Exceptions

NSInvalidArgumentException

Raised if any supplied arguments are `nil`.

Since

6.0

Extends class PTDiffusionMessagingFeature.

sendRequest:toPath:stringCompletionHandler:

- (void) sendRequest:		(PTDiffusionRequest *)	request
toPath:		(NSString *)	path
stringCompletionHandler:		(void(^)(NSString *_Nullable string, NSError *_Nullable error))	completionHandler

Send a request for which a string response is expected.

The message will be routed to an appropriately registered control handler for the given path.

Parameters

request	The request to send.
path	The path to send the request to.
completionHandler	Block to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.

Exceptions

NSInvalidArgumentException

Raised if any supplied arguments are `nil`.

Since

6.0

Extends class PTDiffusionMessagingFeature.

sendRequest:toSessionId:path:doubleFloatNumberCompletionHandler:

- (void) sendRequest:		(PTDiffusionRequest *)	request
toSessionId:		(PTDiffusionSessionId *)	sessionId
path:		(NSString *)	path
doubleFloatNumberCompletionHandler:		(void(^)(NSNumber *_Nullable string, NSError *_Nullable error))	completionHandler

Send a request to a session for which a double-precision floating point (Eight-byte IEEE 754) response is expected.

Parameters

request	The request to send.
sessionId	The session to send the request to.
path	The path to send the request to.
completionHandler	Block to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.

Exceptions

NSInvalidArgumentException

Raised if any supplied arguments are `nil`.

Since

6.5

Extends class PTDiffusionMessagingFeature.

sendRequest:toSessionId:path:int64NumberCompletionHandler:

- (void) sendRequest:		(PTDiffusionRequest *)	request
toSessionId:		(PTDiffusionSessionId *)	sessionId
path:		(NSString *)	path
int64NumberCompletionHandler:		(void(^)(NSNumber *_Nullable string, NSError *_Nullable error))	completionHandler

Send a request to a session for which a 64-bit integer response is expected.

Parameters

request	The request to send.
sessionId	The session to send the request to.
path	The path to send the request to.
completionHandler	Block to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.

Exceptions

NSInvalidArgumentException

Raised if any supplied arguments are `nil`.

Since

6.5

Extends class PTDiffusionMessagingFeature.

sendRequest:toSessionId:path:stringCompletionHandler:

- (void) sendRequest:		(PTDiffusionRequest *)	request
toSessionId:		(PTDiffusionSessionId *)	sessionId
path:		(NSString *)	path
stringCompletionHandler:		(void(^)(NSString *_Nullable string, NSError *_Nullable error))	completionHandler

Send a request to a session for which a string response is expected.

Parameters

request	The request to send.
sessionId	The session to send the request to.
path	The path to send the request to.
completionHandler	Block to be called asynchronously on success or failure. If the operation was successful, the error argument passed to the block will be nil. The completion handler will be called asynchronously on the main dispatch queue.

Exceptions

NSInvalidArgumentException

Raised if any supplied arguments are `nil`.

Since

6.5

Extends class PTDiffusionMessagingFeature.