WSCFrameFactory Class Reference
Inherits from | NSObject |
---|---|
Declared in | WSCFrameFactory.h |
+ createFrame:verb:pack:sessionId:subSessionId:correlationId:
Creates a JSON frame with arguments and a correlation id.
+ (WSCFrame *)createFrame:(MessageType)messageType verb:(NSString *)verb pack:(NSString *)pack sessionId:(NSString *)sessionId subSessionId:(NSString *)subSessionId correlationId:(NSString *)correlationId
Parameters
messageType |
Frame type |
---|---|
verb |
Frame verb |
pack |
Package |
sessionId |
Session Id |
subSessionId |
SubSession Id |
correlationId |
Correlation Id |
Return Value
the newly created frame
Discussion
Creates a JSON frame with arguments and a correlation id.
Declared In
WSCFrameFactory.h
+ createError:code:reason:
Creates a JSON frame of type {@link Type#ERROR} from the original frame.
+ (WSCFrame *)createError:(WSCFrame *)origFrame code:(int)code reason:(NSString *)reason
Parameters
origFrame |
the original Frame |
---|---|
code |
error code |
reason |
failure reason |
Return Value
JSON error frame
Discussion
Creates a JSON frame of type {@link Type#ERROR} from the original frame.
Declared In
WSCFrameFactory.h
+ createAck:
Creates a JSON frame of type {@link Type#ACKNOWLEDGEMENT}.
+ (WSCFrame *)createAck:(WSCFrame *)frame
Parameters
frame |
the original frame |
---|
Return Value
the ACK frame
Discussion
Creates a JSON frame of type {@link Type#ACKNOWLEDGEMENT}.
Declared In
WSCFrameFactory.h
+ createFrame:type:
Creates a JSON frame based on an existing frame
+ (WSCFrame *)createFrame:(WSCFrame *)origFrame type:(MessageType)type
Parameters
origFrame |
Original frame |
---|---|
type |
Messaeg type |
Discussion
Creates a JSON frame based on an existing frame
Declared In
WSCFrameFactory.h