enum VortexFrameType
 

Describes the type allowed for a frame or the type a frame actually have.

Every frame used inside Vortex Library have one of the following values.

Enumerator:
VORTEX_FRAME_TYPE_UNKNOWN  The frame type is unknown, used to represent errors across the Vortex Library.

This only means an error have happen while receiving the frame or while creating a new one. This frame have no valid use inside the Vortex Library.

VORTEX_FRAME_TYPE_MSG  Frame type is MSG.

It is used to represent new Vortex messages.

This frame type represent a new message or a frame which belongs to a set of frame conforming a message. This types of frames are generated while using the following function:

VORTEX_FRAME_TYPE_RPY  Frame type is RPY.

It is used to represent reply frames to MSG frames called positive replies.

This frame type represent replies produced to frame with type MSG. The following function allows to generate frame types for RPY:

VORTEX_FRAME_TYPE_ANS  Frame type is ANS.

It is used to represent reply frames to MSG frames using the type ANS.

VORTEX_FRAME_TYPE_ERR  Frame type is ERR.

It is used to represent reply frames to MSG frames called negative replies.

This frame type is used to represent negative replies to received frames with type MSG. The following functions allows to generate ERR frames:

VORTEX_FRAME_TYPE_NUL  Frame type is NUL.

It is used to represent reply frames to MSG ending a set of ANS frame replies.

VORTEX_FRAME_TYPE_SEQ  Frame type is SEQ.

This is a especial frame type used to allow application level to tweak how big is the window size for a given channel.