Inherits from NSObject
Conforms to NSCopying
Declared in KGWebSocketExtensionParameter.h

Overview

KGWebSocketExtensionParameter represents an extension parameter.

Tasks

  • – extension

    Returns the parent KGWebSocketExtension that this parameter is defined in.

  • – isAnonymous

    Indicates whether the parameter is anonymous or named. If the parameter is anonymous and it is not transient, then it’s name is NOT put on the wire during the handshake. However, it’s value is put on the wire.

  • – isTemporal

    Indicates whether the parameter is temporal. Temporal parameters are not put on the wire during the handshake.

  • – isRequired

    Indicates whether the parameter is required. If the required parameter is not set, then the extension is not negotiated during the handshake.

  • – metadata

    Returns the metadata characteristics of this extension parameter. The returned EnumSet is a clone so any changes to it will not be picked by by the extension parameter.

  • – name

    Returns the name of the parameter.

  • – type

    Returns the type of the parameter value.

Instance Methods

extension

Returns the parent KGWebSocketExtension that this parameter is defined in.

- (KGWebSocketExtension *)extension

Declared In

KGWebSocketExtensionParameter.h

isAnonymous

Indicates whether the parameter is anonymous or named. If the parameter is anonymous and it is not transient, then it’s name is NOT put on the wire during the handshake. However, it’s value is put on the wire.

- (BOOL)isAnonymous

Declared In

KGWebSocketExtensionParameter.h

isRequired

Indicates whether the parameter is required. If the required parameter is not set, then the extension is not negotiated during the handshake.

- (BOOL)isRequired

Declared In

KGWebSocketExtensionParameter.h

isTemporal

Indicates whether the parameter is temporal. Temporal parameters are not put on the wire during the handshake.

- (BOOL)isTemporal

Declared In

KGWebSocketExtensionParameter.h

metadata

Returns the metadata characteristics of this extension parameter. The returned EnumSet is a clone so any changes to it will not be picked by by the extension parameter.

- (NSSet *)metadata

Declared In

KGWebSocketExtensionParameter.h

name

Returns the name of the parameter.

- (NSString *)name

Declared In

KGWebSocketExtensionParameter.h

type

Returns the type of the parameter value.

- (Class)type

Declared In

KGWebSocketExtensionParameter.h