HaltMessage

Complexity

Total Complexity

3

Size/Duplication

Total Lines	38
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	create_message()	0	8	1
A	send_message()	0	9	1
A	__init__()	0	5	1

"""
Enarksh

Copyright 2013-2016 Set Based IT Consultancy

Licence MIT
"""
from enarksh.message.Message import Message


class HaltMessage(Message):
    """
    Message type for instructing a daemon of Enarksh to halt.
    """
    MESSAGE_TYPE = 'HaltMessage'
    """
    The message type.

    :type: str
    """

    # ------------------------------------------------------------------------------------------------------------------
    def __init__(self):
        """
        Object constructor.
        """
        Message.__init__(self, HaltMessage.MESSAGE_TYPE)

    # ------------------------------------------------------------------------------------------------------------------
    @staticmethod
    def create_message(_):
        """
        Create a message of this class based on JSON data.

        :rtype: enarksh.message.HaltMessage.HaltMessage
        """
        return HaltMessage()

    # ------------------------------------------------------------------------------------------------------------------
    def send_message(self, end_point):
        """
        Sends the message to an end point.

        :param str end_point: The end point.

        :rtype: None
        """
        self.message_controller.send_message(end_point, self)

# ----------------------------------------------------------------------------------------------------------------------