Source code for spinnman.messages.eieio.command_messages.host_send_sequenced_data

# Copyright (c) 2015 The University of Manchester
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import struct

from spinn_utilities.overrides import overrides
from spinnman.constants import EIEIO_COMMAND_IDS
from spinnman.messages.eieio import AbstractEIEIOMessage
from spinnman.messages.eieio.create_eieio_data import read_eieio_data_message

from .eieio_command_message import EIEIOCommandMessage
from .eieio_command_header import EIEIOCommandHeader


_PATTERN_BB = struct.Struct("<BB")


class HostSendSequencedData(EIEIOCommandMessage):
    """
    Packet sent from the host to the SpiNNaker system in the context of
    buffering input mechanism to identify packet which needs to be stored
    in memory for future use.
    """
    __slots__ = (
        "_eieio_data_message",
        "_region_id",
        "_sequence_no")

    def __init__(self, region_id: int, sequence_no: int,
                 eieio_data_message: AbstractEIEIOMessage):
        """

        :param int region_id:
        :param int sequence_no:
        :param AbstractEIEIOMessage eieio_data_message:
        """
        super().__init__(EIEIOCommandHeader(
            EIEIO_COMMAND_IDS.HOST_SEND_SEQUENCED_DATA))
        self._region_id = region_id
        self._sequence_no = sequence_no
        self._eieio_data_message = eieio_data_message

    @property
    def region_id(self) -> int:
        """
        The region_id passed into the init.

        :rtype: int
        """
        return self._region_id

    @property
    def sequence_no(self) -> int:
        """
        The sequence_no passed into the init.

        :rtype: int
        """
        return self._sequence_no

    @property
    def eieio_data_message(self) -> AbstractEIEIOMessage:
        """
        The eieio_data_message passed into the init.

        :return: AbstractEIEIOMessage
        """
        return self._eieio_data_message



    @staticmethod
    @overrides(EIEIOCommandMessage.get_min_packet_length)
    def get_min_packet_length() -> int:
        return 4




    @staticmethod
    @overrides(EIEIOCommandMessage.from_bytestring)
    def from_bytestring(command_header: EIEIOCommandHeader, data: bytes,
                        offset: int) -> "HostSendSequencedData":
        region_id, sequence_no = _PATTERN_BB.unpack_from(data, offset)
        eieio_data_message = read_eieio_data_message(data, offset)
        return HostSendSequencedData(
            region_id, sequence_no, eieio_data_message)


    @property
    @overrides(EIEIOCommandMessage.bytestring)
    def bytestring(self) -> bytes:
        return (super().bytestring +
                _PATTERN_BB.pack(self._region_id, self._sequence_no) +
                self._eieio_data_message.bytestring)