KGWebSocketExtensionParameter Class Reference
| Inherits from | NSObject |
| Conforms to | NSCopying |
| Declared in | KGWebSocketExtensionParameter.h |
Tasks
-
– extensionReturns the parent KGWebSocketExtension that this parameter is defined in.
-
– isAnonymousIndicates 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.
-
– isTemporalIndicates whether the parameter is temporal. Temporal parameters are not put on the wire during the handshake.
-
– isRequiredIndicates whether the parameter is required. If the required parameter is not set, then the extension is not negotiated during the handshake.
-
– metadataReturns 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.
-
– nameReturns the name of the parameter.
-
– typeReturns the type of the parameter value.
Instance Methods
extension
Returns the parent KGWebSocketExtension that this parameter is defined in.
- (KGWebSocketExtension *)extensionDeclared In
KGWebSocketExtensionParameter.hisAnonymous
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)isAnonymousDeclared In
KGWebSocketExtensionParameter.hisRequired
Indicates whether the parameter is required. If the required parameter is not set, then the extension is not negotiated during the handshake.
- (BOOL)isRequiredDeclared In
KGWebSocketExtensionParameter.hisTemporal
Indicates whether the parameter is temporal. Temporal parameters are not put on the wire during the handshake.
- (BOOL)isTemporalDeclared In
KGWebSocketExtensionParameter.hmetadata
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 *)metadataDeclared In
KGWebSocketExtensionParameter.h