FMLiveSwitchDatagramSocket Class Reference

A datagram socket. More...

Instance Methods
(instancetype)	- init
(int)	- maxQueuedPackets
	Gets the maximum number of packets that can be queued at any given point in time. More...
(void)	- raiseReceiveFailureWithCallback:exception:
	Invokes the receive failure callback. More...
(void)	- raiseReceiveFailureWithCallbackBlock:exception:
	Invokes the receive failure callback. More...
(NSException *)	- raiseReceiveFailureWithCallbackBlockAndException
	Invokes the receive failure callback. More...
(void)	- raiseReceiveSuccessWithCallback:buffer:ipAddress:port:
	Invokes the receive success callback. More...
(void)	- raiseReceiveSuccessWithCallbackBlock:buffer:ipAddress:port:
	Invokes the receive success callback. More...
(FMLiveSwitchDataBuffer *, NSString *, int)	- raiseReceiveSuccessWithCallbackBlockAndBufferAndIPAddressAndPort
	Invokes the receive success callback. More...
(void)	- receiveAsyncWithOnSuccess:onFailure:
	Receives data asynchronously. More...
(void)	- receiveAsyncWithOnSuccessBlock:onFailureBlock:
	Receives data asynchronously. More...
(NSException *)	- receiveAsyncWithOnSuccessBlockAndOnFailureBlock
	Receives data asynchronously. More...
(int)	- receiveBufferSize
	Gets the current receive buffer size. More...
(int)	- sendBufferSize
	Gets the current send buffer size. More...
(FMLiveSwitchError *)	- sendWithBuffer:ipAddress:port:
	Sends data synchronously. More...
(void)	- setMaxQueuedPackets:
	Sets the maximum number of packets that can be queued at any given point in time. More...
Instance Methods inherited from FMLiveSwitchManagedSocket
(long long)	- adapterSpeed
	Gets the adapter speed. More...
(bool)	- bindWithIPAddress:port:addressInUse:
	Binds the socket to a local endpoint. More...
(void)	- close
	Closes the socket. More...
(bool)	- ipv6
	Gets a value indicating whether the socket supports IPv6. More...
(bool)	- isClosed
	Gets a value indicating whether this instance is closed. More...
(NSString *)	- localIPAddress
	Gets the local IP address. More...
(int)	- localPort
	Gets the local port. More...
(NSMutableArray *)	- publicIPAddresses
	Gets the public IP addresses, if known. More...
(void)	- setAdapterSpeed:
	Sets the adapter speed. More...
(void)	- setPublicIPAddresses:
	Sets the public IP addresses, if known. More...

Class Methods
(FMLiveSwitchDatagramSocket *)	+ datagramSocket
Class Methods inherited from FMLiveSwitchManagedSocket
(FMLiveSwitchManagedSocket *)	+ managedSocket

Detailed Description

A datagram socket.

Method Documentation

datagramSocket

+ (FMLiveSwitchDatagramSocket*) datagramSocket

init

- (instancetype) init

Implements FMLiveSwitchManagedSocket.

maxQueuedPackets

- (int) maxQueuedPackets

Gets the maximum number of packets that can be queued at any given point in time.

Implemented in FMLiveSwitchVirtualUdpSocket.

raiseReceiveFailureWithCallback:exception:

- (void) raiseReceiveFailureWithCallback:		(FMLiveSwitchAction1< NSException * > *)	callback
exception:		(NSException *)	exception

Invokes the receive failure callback.

Parameters

callback	The callback.
exception	The exception.

raiseReceiveFailureWithCallbackBlock:exception:

- (void) raiseReceiveFailureWithCallbackBlock:		(void(^)(NSException *))	callbackBlock
exception:		(NSException *)	exception

Invokes the receive failure callback.

Parameters

callbackBlock	The callback.
exception	The exception.

raiseReceiveFailureWithCallbackBlockAndException

- (NSException*) raiseReceiveFailureWithCallbackBlockAndException

Invokes the receive failure callback.

@inlineparam callbackBlock The callback. @inlineparam exception The exception.

raiseReceiveSuccessWithCallback:buffer:ipAddress:port:

- (void) raiseReceiveSuccessWithCallback:		(FMLiveSwitchAction3< FMLiveSwitchDataBuffer *, NSString *, id > *)	callback
buffer:		(FMLiveSwitchDataBuffer *)	buffer
ipAddress:		(NSString *)	ipAddress
port:		(int)	port

Invokes the receive success callback.

Parameters

callback	The callback.
buffer	The buffer.
ipAddress	The IP address.
port	The port.

raiseReceiveSuccessWithCallbackBlock:buffer:ipAddress:port:

- (void) raiseReceiveSuccessWithCallbackBlock:		(void(^)(FMLiveSwitchDataBuffer *, NSString *, int))	callbackBlock
buffer:		(FMLiveSwitchDataBuffer *)	buffer
ipAddress:		(NSString *)	ipAddress
port:		(int)	port

Invokes the receive success callback.

Parameters

callbackBlock	The callback.
buffer	The buffer.
ipAddress	The IP address.
port	The port.

raiseReceiveSuccessWithCallbackBlockAndBufferAndIPAddressAndPort

- (FMLiveSwitchDataBuffer*, NSString*, int) raiseReceiveSuccessWithCallbackBlockAndBufferAndIPAddressAndPort

Invokes the receive success callback.

@inlineparam callbackBlock The callback. @inlineparam buffer The buffer. @inlineparam ipAddress The IP address. @inlineparam port The port.

receiveAsyncWithOnSuccess:onFailure:

- (void) receiveAsyncWithOnSuccess:		(FMLiveSwitchAction3< FMLiveSwitchDataBuffer *, NSString *, id > *)	onSuccess
onFailure:		(FMLiveSwitchAction1< NSException * > *)	onFailure

Receives data asynchronously.

Parameters

onSuccess	The callback to invoke on success.
onFailure	The callback to invoke on failure.

Implemented in FMLiveSwitchVirtualUdpSocket.

receiveAsyncWithOnSuccessBlock:onFailureBlock:

- (void) receiveAsyncWithOnSuccessBlock:		(void(^)(FMLiveSwitchDataBuffer *, NSString *, int))	onSuccessBlock
onFailureBlock:		(void(^)(NSException *))	onFailureBlock

Receives data asynchronously.

Parameters

onSuccessBlock	The callback to invoke on success.
onFailureBlock	The callback to invoke on failure.

Implemented in FMLiveSwitchVirtualUdpSocket.

receiveAsyncWithOnSuccessBlockAndOnFailureBlock

- (NSException*) receiveAsyncWithOnSuccessBlockAndOnFailureBlock

Receives data asynchronously.

@inlineparam onSuccessBlock The callback to invoke on success. @inlineparam onFailureBlock The callback to invoke on failure.

Implemented in FMLiveSwitchVirtualUdpSocket.

receiveBufferSize

- (int) receiveBufferSize

Gets the current receive buffer size.

Implemented in FMLiveSwitchVirtualUdpSocket.

sendBufferSize

- (int) sendBufferSize

Gets the current send buffer size.

Implemented in FMLiveSwitchVirtualUdpSocket.

sendWithBuffer:ipAddress:port:

- (FMLiveSwitchError*) sendWithBuffer:		(FMLiveSwitchDataBuffer *)	buffer
ipAddress:		(NSString *)	ipAddress
port:		(int)	port

Sends data synchronously.

Parameters

buffer	The buffer.
ipAddress	The remote IP address.
port	The remote port.

Implemented in FMLiveSwitchVirtualUdpSocket.

setMaxQueuedPackets:

- (void) setMaxQueuedPackets:

(int)

value

Sets the maximum number of packets that can be queued at any given point in time.

Implemented in FMLiveSwitchVirtualUdpSocket.