FMTcpConnectArgs Class Reference

Inherits from FMDynamic : FMSerializable : NSObject
Declared in FM.h

Overview

TCP connect arguments.

– initWithIPAddress:port:state:

Initializes a new instance of the class.

- (id)initWithIPAddress:(NSString *)ipAddress port:(int)port state:(NSObject *)state

Parameters

name="ipAddress">The

remote IP address.
name="port">The

remote port.
name="state">The

custom state object.

Discussion

Initializes a new instance of the class.

Declared In

FM.h

– initWithIPAddress:port:state:timeout:

Initializes a new instance of the class.

- (id)initWithIPAddress:(NSString *)ipAddress port:(int)port state:(NSObject *)state timeout:(int)timeout

Parameters

name="ipAddress">The

remote IP address.
name="port">The

remote port.
name="timeout">The

timeout.
name="state">The

custom state object.

Discussion

Initializes a new instance of the class.

Declared In

FM.h

– ipAddress

Gets the remote IP address.

- (NSString *)ipAddress

Discussion

Gets the remote IP address.

Declared In

FM.h

– onComplete

Gets the callback to invoke on complete.

- (FMCallback *)onComplete

Discussion

Gets the callback to invoke on complete.

Declared In

FM.h

– onFailure

Gets the callback to invoke on failure.

- (FMCallback *)onFailure

Discussion

Gets the callback to invoke on failure.

Declared In

FM.h

– onSuccess

Gets the callback to invoke on success.

- (FMCallback *)onSuccess

Discussion

Gets the callback to invoke on success.

Declared In

FM.h

– port

Gets the remote port.

- (int)port

Discussion

Gets the remote port.

Declared In

FM.h

– setIPAddress:

Sets the remote IP address.

- (void)setIPAddress:(NSString *)value

Discussion

Sets the remote IP address.

Declared In

FM.h

– setOnComplete:

Sets the callback to invoke on complete.

- (void)setOnComplete:(FMCallback *)value

Discussion

Sets the callback to invoke on complete.

Declared In

FM.h

– setOnCompleteBlock:

Sets the callback to invoke on complete.

- (void)setOnCompleteBlock:(void ( ^ ) ( FMTcpConnectCompleteArgs *))valueBlock

Discussion

Sets the callback to invoke on complete.

Declared In

FM.h

– setOnFailure:

Sets the callback to invoke on failure.

- (void)setOnFailure:(FMCallback *)value

Discussion

Sets the callback to invoke on failure.

Declared In

FM.h

– setOnFailureBlock:

Sets the callback to invoke on failure.

- (void)setOnFailureBlock:(void ( ^ ) ( FMTcpConnectFailureArgs *))valueBlock

Discussion

Sets the callback to invoke on failure.

Declared In

FM.h

– setOnSuccess:

Sets the callback to invoke on success.

- (void)setOnSuccess:(FMCallback *)value

Discussion

Sets the callback to invoke on success.

Declared In

FM.h

– setOnSuccessBlock:

Sets the callback to invoke on success.

- (void)setOnSuccessBlock:(void ( ^ ) ( FMTcpConnectSuccessArgs *))valueBlock

Discussion

Sets the callback to invoke on success.

Declared In

FM.h

– setPort:

Sets the remote port.

- (void)setPort:(int)value

Discussion

Sets the remote port.

Declared In

FM.h

– setState:

Sets the custom state object.

- (void)setState:(NSObject *)value

Discussion

Sets the custom state object.

Declared In

FM.h

– setTimeout:

Sets the timeout.

- (void)setTimeout:(int)value

Discussion

Sets the timeout.

Declared In

FM.h

– state

Gets the custom state object.

- (NSObject *)state

Discussion

Gets the custom state object.

Declared In

FM.h

+ tcpConnectArgsWithIPAddress:port:state:

Initializes a new instance of the class.

+ (FMTcpConnectArgs *)tcpConnectArgsWithIPAddress:(NSString *)ipAddress port:(int)port state:(NSObject *)state

Parameters

name="ipAddress">The

remote IP address.
name="port">The

remote port.
name="state">The

custom state object.

Discussion

Initializes a new instance of the class.

Declared In

FM.h

+ tcpConnectArgsWithIPAddress:port:state:timeout:

Initializes a new instance of the class.

+ (FMTcpConnectArgs *)tcpConnectArgsWithIPAddress:(NSString *)ipAddress port:(int)port state:(NSObject *)state timeout:(int)timeout

Parameters

name="ipAddress">The

remote IP address.
name="port">The

remote port.
name="timeout">The

timeout.
name="state">The

custom state object.

Discussion

Initializes a new instance of the class.

Declared In

FM.h

– timeout

Gets the timeout.

- (int)timeout

Discussion

Gets the timeout.

Declared In

FM.h

– willTimeout

Gets whether the send will timeout eventually.

- (bool)willTimeout

Discussion

Gets whether the send will timeout eventually.

Declared In

FM.h