vortex.frame
— LuaVortexFrame class: BEEP frame representation¶API documentation for vortex.frame object representing a BEEP frame received.
vortex.
Frame
¶check
(frame)¶Parameters: | frame (vortex.frame) – The frame. |
---|
Allows to check if the provided vortex.frame
is indeed a vortex.frame
object.
Return type: | Returns true in the case it is a vortex.frame object. Otherwise, false is returned. |
---|
id
¶(Read only attribute) (Number) returns frame unique identifier
type
¶(Read only attribute) (String) returns the frame type: MSG, RPY, ERR, ANS, NUL and SEQ.
msgno
¶(Read only attribute) (Number) returns the frame msgno value. It is also accepted msg_no
msg_no
¶(Read only attribute) (Number) msgno alias
seqno
¶(Read only attribute) (Number) returns the frame seqno value. It is also accepted seq_no
seq_no
¶(Read only attribute) (Number) seqno alias
ansno
¶(Read only attribute) (Number) returns the frame ansno value. It is also accepted ans_no
ans_no
¶(Read only attribute) (Number) ansno alias
more_flag
¶(Read only attribute) (true/false) returns more flag status on the frame
payload_size
¶(Read only attribute) (Number) returns the payload size (frame content without MIME headers).
content_size
¶(Read only attribute) (Number) returns the content size (frame content including MIME headers).
payload
¶(Read only attribute) (String) returns frame content without including MIME headers
content
¶(Read only attribute) (String) returns frame content including MIME headers