Source code for alignak.message

#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# Copyright (C) 2015-2015: Alignak team, see AUTHORS.txt file for contributors
#
# This file is part of Alignak.
#
# Alignak is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Alignak is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with Alignak.  If not, see <http://www.gnu.org/licenses/>.
#
#
# This file incorporates work covered by the following copyright and
# permission notice:
#
#  Copyright (C) 2009-2014:
#     Jean Gabes, naparuba@gmail.com
#     Hartmut Goebel, h.goebel@goebel-consult.de
#     Grégory Starck, g.starck@gmail.com
#     Zoran Zaric, zz@zoranzaric.de
#     Sebastien Coavoux, s.coavoux@free.fr

#  This file is part of Shinken.
#
#  Shinken is free software: you can redistribute it and/or modify
#  it under the terms of the GNU Affero General Public License as published by
#  the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.
#
#  Shinken is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU Affero General Public License for more details.
#
#  You should have received a copy of the GNU Affero General Public License
#  along with Shinken.  If not, see <http://www.gnu.org/licenses/>.
"""This module provides Message class. Used for communication between daemon process (with queues)

"""


[docs]class Message: """This is a simple message class for communications between actionners and workers """ my_type = 'message' _type = None _data = None _from = None def __init__(self, _id, _type, data=None, source=None): self._type = _type self._data = data self._from = _id self.source = source
[docs] def get_type(self): """Getter of _type attribute :return: Message type :rtype: str """ return self._type
[docs] def get_data(self): """Getter of _data attribute :return: Message data :rtype: str """ return self._data
[docs] def get_from(self): """Getter of _from attribute :return: Message from (worker name) :rtype: str """ return self._from
[docs] def str(self): """String representation of message :return: "Message from %d (%s), Type: %s Data: %s" (from, source, type, data) :rtype: str TODO: Rename this __str__ """ return "Message from %d (%s), Type: %s Data: %s" % ( self._from, self.source, self._type, self._data)