Skip to content

basic_codec

Classes

BasicCodec 

BasicCodec()

Version of this codec.

Source code in heartkit/backends/erpc/codec.py 
28
29
def __init__(self):
    self.reset()

Functions

start_read_message 
start_read_message() -> MessageInfo

Returns 4-tuple of msgType, service, request, sequence.

Raises:

  • CodecError –

    Raise this error when unsupported codec version doesn't match.

Returns:

  • MessageInfo –

    codec.MessageInfo: 4-tuple of msgType, service, request, sequence.

Source code in heartkit/backends/erpc/basic_codec.py 
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def start_read_message(self) -> MessageInfo:
    """Returns 4-tuple of msgType, service, request, sequence.

    Raises:
        CodecError: Raise this error when unsupported codec version doesn't match.

    Returns:
        codec.MessageInfo: 4-tuple of msgType, service, request, sequence.
    """
    header = self.read_uint32()
    sequence = self.read_uint32()
    version = header >> 24
    if version != self.BASIC_CODEC_VERSION:
        raise CodecError("unsupported codec version %d" % version)
    service = (header >> 16) & 0xFF
    request = (header >> 8) & 0xFF
    msgType = MessageType(header & 0xFF)
    return MessageInfo(type=msgType, service=service, request=request, sequence=sequence)
start_read_list 
start_read_list() -> int

Function which should be called on list de-serialization.

Returns:

  • int ( int ) –

    Int of list length.

Source code in heartkit/backends/erpc/basic_codec.py 
149
150
151
152
153
154
155
def start_read_list(self) -> int:
    """Function which should be called on list de-serialization.

    Returns:
        int: Int of list length.
    """
    return self.read_uint32()
start_read_union 
start_read_union() -> int

Function which should be called on union de-serialization.

Returns:

  • int ( int ) –

    Int of union discriminator.

Source code in heartkit/backends/erpc/basic_codec.py 
157
158
159
160
161
162
163
def start_read_union(self) -> int:
    """Function which should be called on union de-serialization.

    Returns:
        int: Int of union discriminator.
    """
    return self.read_int32()