text
stringlengths 0
828
|
|---|
packet_type: MqttControlPacketType
|
flags: int
|
Integer representation of 4-bit MQTT header flags field.
|
Values outside of the range [0, 15] will certainly cause the
|
function to return False.
|
Returns
|
-------
|
bool
|
""""""
|
if packet_type == MqttControlPacketType.publish:
|
rv = 0 <= flags <= 15
|
elif packet_type in (MqttControlPacketType.pubrel,
|
MqttControlPacketType.subscribe,
|
MqttControlPacketType.unsubscribe):
|
rv = flags == 2
|
elif packet_type in (MqttControlPacketType.connect,
|
MqttControlPacketType.connack,
|
MqttControlPacketType.puback,
|
MqttControlPacketType.pubrec,
|
MqttControlPacketType.pubcomp,
|
MqttControlPacketType.suback,
|
MqttControlPacketType.unsuback,
|
MqttControlPacketType.pingreq,
|
MqttControlPacketType.pingresp,
|
MqttControlPacketType.disconnect):
|
rv = flags == 0
|
else:
|
raise NotImplementedError(packet_type)
|
return rv"
|
1168,"def decode(f):
|
""""""Extract a `MqttFixedHeader` from ``f``.
|
Parameters
|
----------
|
f: file
|
Object with read method.
|
Raises
|
-------
|
DecodeError
|
When bytes decoded have values incompatible with a
|
`MqttFixedHeader` object.
|
UnderflowDecodeError
|
When end-of-stream is encountered before the end of the
|
fixed header.
|
Returns
|
-------
|
int
|
Number of bytes consumed from ``f``.
|
MqttFixedHeader
|
Header object extracted from ``f``.
|
""""""
|
decoder = mqtt_io.FileDecoder(f)
|
(byte_0,) = decoder.unpack(mqtt_io.FIELD_U8)
|
packet_type_u4 = (byte_0 >> 4)
|
flags = byte_0 & 0x0f
|
try:
|
packet_type = MqttControlPacketType(packet_type_u4)
|
except ValueError:
|
raise DecodeError('Unknown packet type 0x{:02x}.'.format(packet_type_u4))
|
if not are_flags_valid(packet_type, flags):
|
raise DecodeError('Invalid flags for packet type.')
|
num_bytes, num_remaining_bytes = decoder.unpack_varint(4)
|
return decoder.num_bytes_consumed, MqttFixedHeader(packet_type, flags, num_remaining_bytes)"
|
1169,"def encode_body(self, f):
|
""""""
|
Parameters
|
----------
|
f: file
|
File-like object with a write method.
|
Returns
|
-------
|
int
|
Number of bytes written to ``f``.
|
""""""
|
num_bytes_written = 0
|
num_bytes_written += self.__encode_name(f)
|
num_bytes_written += self.__encode_protocol_level(f)
|
num_bytes_written += self.__encode_connect_flags(f)
|
num_bytes_written += self.__encode_keep_alive(f)
|
num_bytes_written += mqtt_io.encode_utf8(self.client_id, f)
|
if self.will is not None:
|
num_bytes_written += mqtt_io.encode_utf8(self.will.topic, f)
|
num_bytes_written += mqtt_io.encode_bytes(self.will.message, f)
|
if self.username is not None:
|
num_bytes_written += mqtt_io.encode_utf8(self.username, f)
|
if self.password is not None:
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.