IceLink

"Frozen Mountain Software"

FMIceLinkIceServer Class Reference

Inherits from	NSObject
Declared in	FMIceLinkIceServer.h FMIceLinkIceServer.m

Overview

An ICE server.

`+ defaultPort`

Gets the default [port](#//api/name/port).

+ (int)defaultPort

Discussion

Gets the default [port](#//api/name/port).

Declared In

FMIceLinkIceServer.h

`+ fromJsonArrayWithIceServersJson:`

Deserializes an array of instances from JSON.

+ (NSMutableArray *)fromJsonArrayWithIceServersJson:(NSString *)iceServersJson

Parameters

`iceServersJson`	The JSON to deserialize.

Return Value

The deserialized ICE server array.

Discussion

Deserializes an array of instances from JSON.

Declared In

FMIceLinkIceServer.h

`+ fromJsonWithIceServerJson:`

Deserializes an instance from JSON.

+ (FMIceLinkIceServer *)fromJsonWithIceServerJson:(NSString *)iceServerJson

Parameters

`iceServerJson`	The JSON to deserialize.

Return Value

The deserialized ICE server.

Discussion

Deserializes an instance from JSON.

Declared In

FMIceLinkIceServer.h

`– host`

Gets the host.

- (NSString *)host

Discussion

Gets the host.

Declared In

FMIceLinkIceServer.h

`+ iceServerWithUrl:`

Initializes a new instance of the FMIceLinkIceServer class.

+ (FMIceLinkIceServer *)iceServerWithUrl:(NSString *)url

Parameters

`url`	The URL.

Discussion

Initializes a new instance of the FMIceLinkIceServer class.

Declared In

FMIceLinkIceServer.h

`+ iceServerWithUrl:username:password:`

Initializes a new instance of the FMIceLinkIceServer class.

+ (FMIceLinkIceServer *)iceServerWithUrl:(NSString *)url username:(NSString *)username password:(NSString *)password

Parameters

`url`	The URL.
`username`	The username.
`password`	The password.

Discussion

Initializes a new instance of the FMIceLinkIceServer class.

Declared In

FMIceLinkIceServer.h

`– initWithUrl:`

Initializes a new instance of the FMIceLinkIceServer class.

- (instancetype)initWithUrl:(NSString *)url

Parameters

`url`	The URL.

Discussion

Initializes a new instance of the FMIceLinkIceServer class.

Declared In

FMIceLinkIceServer.h

`– initWithUrl:username:password:`

Initializes a new instance of the FMIceLinkIceServer class.

- (instancetype)initWithUrl:(NSString *)url username:(NSString *)username password:(NSString *)password

Parameters

`url`	The URL.
`username`	The username.
`password`	The password.

Discussion

Initializes a new instance of the FMIceLinkIceServer class.

Declared In

FMIceLinkIceServer.h

`– isSecure`

Gets a value indicating whether this represents a secure STUN or TURN server.

- (bool)isSecure

Discussion

Gets a value indicating whether this represents a secure STUN or TURN server.

Declared In

FMIceLinkIceServer.h

`– isStun`

Gets a value indicating whether this represents a STUN server.

- (bool)isStun

Discussion

Gets a value indicating whether this represents a STUN server.

Declared In

FMIceLinkIceServer.h

`– isTcp`

Gets a value indicating whether this represents a TCP server.

- (bool)isTcp

Discussion

Gets a value indicating whether this represents a TCP server.

Declared In

FMIceLinkIceServer.h

`– isTurn`

Gets a value indicating whether this represents a TURN server.

- (bool)isTurn

Discussion

Gets a value indicating whether this represents a TURN server.

Declared In

FMIceLinkIceServer.h

`– isUdp`

Gets a value indicating whether this represents a UDP server.

- (bool)isUdp

Discussion

Gets a value indicating whether this represents a UDP server.

Declared In

FMIceLinkIceServer.h

`– password`

Gets the password.

- (NSString *)password

Discussion

Gets the password.

Declared In

FMIceLinkIceServer.h

`– port`

Gets the port.

- (int)port

Discussion

Gets the port.

Declared In

FMIceLinkIceServer.h

`– toJson`

Serializes this instance to JSON.

@return The serialized JSON.

- (NSString *)toJson

Discussion

Serializes this instance to JSON.

@return The serialized JSON.

Declared In

FMIceLinkIceServer.h

`+ toJsonArrayWithIceServers:`

Serializes an array of instances to JSON.

+ (NSString *)toJsonArrayWithIceServers:(NSMutableArray *)iceServers

Parameters

`iceServers`	The ICE servers. @return The serialized JSON.

Discussion

Serializes an array of instances to JSON.

Declared In

FMIceLinkIceServer.h

`+ toJsonWithIceServer:`

Serializes an instance to JSON.

+ (NSString *)toJsonWithIceServer:(FMIceLinkIceServer *)iceServer

Parameters

`iceServer`	The ICE server. @return The serialized JSON.

Discussion

Serializes an instance to JSON.

Declared In

FMIceLinkIceServer.h

`– url`

Gets the URL.

- (NSString *)url

Discussion

Gets the URL.

Declared In

FMIceLinkIceServer.h

`– username`

Gets the username.

- (NSString *)username

Discussion

Gets the username.

Declared In

FMIceLinkIceServer.h