Class: VRTQL::Message
- Inherits:
-
Object
- Object
- VRTQL::Message
- Defined in:
- doc/vrtql.rb
Overview
Class: Message
This class represents a VRTQL::Message. It provides methods for creating, managing, and manipulating messages in VRTQL::Connection which uses it as the basis for sending and receiving messages.
Instance Method Summary collapse
-
#content ⇒ Object
Method: content.
-
#content=(content) ⇒ Object
Method: content=.
-
#deserialize(data) ⇒ Object
Method: deserialize.
-
#dump ⇒ Object
Method: dump.
-
#headers ⇒ Object
Method: headers.
-
#headers=(hash) ⇒ Object
Method: headers=.
-
#initialize(msg) ⇒ Message
constructor
Method: initialize.
-
#routing ⇒ Object
Method: routing.
-
#routing=(hash) ⇒ Object
Method: routing=.
-
#serialize ⇒ Object
Method: serialize.
-
#valid? ⇒ Boolean
Method: valid?.
Constructor Details
#initialize(msg) ⇒ Message
Method: initialize
Creates a new VRTQL::Message object.
Parameters:
msg - A pointer to a vrtql_msg struct
57 58 59 |
# File 'doc/vrtql.rb', line 57 def initialize(msg) # Initialization logic end |
Instance Method Details
#content ⇒ Object
Method: content
Retrieves the content from the Message.
Returns:
A string of the content
127 128 129 |
# File 'doc/vrtql.rb', line 127 def content # Get content logic end |
#content=(content) ⇒ Object
Method: content=
Sets the content of the Message.
Parameters:
content - A string representing the content
117 118 119 |
# File 'doc/vrtql.rb', line 117 def content=(content) # Set content logic end |
#deserialize(data) ⇒ Object
Method: deserialize
Deserializes the Message.
Parameters:
data - A string representing the serialized message
Returns:
True if deserialization is successful, false otherwise
150 151 152 |
# File 'doc/vrtql.rb', line 150 def deserialize(data) # Deserialize logic end |
#dump ⇒ Object
Method: dump
Dumps Message to human readable output
157 158 159 |
# File 'doc/vrtql.rb', line 157 def dump # Dump message logic end |
#headers ⇒ Object
Method: headers
Retrieves the headers from the Message.
Returns:
A hash of headers
67 68 69 |
# File 'doc/vrtql.rb', line 67 def headers # Return headers logic end |
#headers=(hash) ⇒ Object
Method: headers=
Sets the headers in the Message.
Parameters:
hash - A hash of headers
87 88 89 |
# File 'doc/vrtql.rb', line 87 def headers=(hash) # Set headers logic end |
#routing ⇒ Object
Method: routing
Retrieves the routing from the Message.
Returns:
A hash of routing
107 108 109 |
# File 'doc/vrtql.rb', line 107 def routing # Return routing logic end |
#routing=(hash) ⇒ Object
Method: routing=
Sets the routing in the Message.
Parameters:
hash - A hash of routing information
97 98 99 |
# File 'doc/vrtql.rb', line 97 def routing=(hash) # Set routing logic end |
#serialize ⇒ Object
Method: serialize
Serializes the Message.
Returns:
A string representing the serialized
137 138 139 |
# File 'doc/vrtql.rb', line 137 def serialize # Serialize logic end |
#valid? ⇒ Boolean
Method: valid?
Checks if the Message is valid.
Returns:
True if the message is valid, false otherwise.
77 78 79 |
# File 'doc/vrtql.rb', line 77 def valid? # Validation logic end |