Modul ncache.runtime.caching.TopicSubscription

Erweitern Sie den Quellcode 
from collections import Callable

from ncache.runtime.caching.events.MessageReceivedListener import MessageReceivedListener
from ncache.util.EventsListenerHelper import EventsListenerHelper
from ncache.util.ValidateType import ValidateType


class TopicSubscription:
    """
    NCache provides TopicSubscription class which is returned against the desired topic,containing information for
    topic subscriptions.
    """
    def __init__(self, value):
        self.__topicsubscription = value

    def get_instance(self):
        return self.__topicsubscription

    def set_instance(self, value):
        self.__topicsubscription = value

    def add_message_received_listener(self, messagereceivedlistener):
        """
        Event to register subscriber against the topic so that it can receive the published messages.

        :param messagereceivedlistener: The listener function that is invoked whenever a message is received. This
            function should follow this signature: message_received_listener(sender: object, args: MessageEventArgs)
        :type messagereceivedlistener: Callable
        """
        ValidateType.params_check(messagereceivedlistener, 2, self.add_message_received_listener)

        eventlistener = EventsListenerHelper.get_listener(messagereceivedlistener, MessageReceivedListener)
        self.__topicsubscription.addMessageReceivedListener(eventlistener)

    def get_topic(self):
        """
        Retrieves Topic instance containing information about the topic.

        :return: Topic instance of the topic.
        :rtype: Topic
        """
        result = self.__topicsubscription.getTopic()

        if result is not None:
            from ncache.runtime.caching.Topic import Topic
            return Topic(result)

    def remove_message_received_listener(self, messagereceivedlistener):
        """
        Unregisters the user for message received event.

        :param messagereceivedlistener: The registered message received listener function.
        :type messagereceivedlistener: Callable
        """
        ValidateType.params_check(messagereceivedlistener, 2, self.remove_message_received_listener)

        listener = EventsListenerHelper.get_listener(messagereceivedlistener, MessageReceivedListener)
        self.__topicsubscription.removeMessageReceivedListener(listener)

    def un_subscribe(self):
        """
        Unsubscribes the subscription to this topic.
        """
        self.__topicsubscription.unSubscribe()

Klassen

class TopicSubscription (value)

NCache stellt die TopicSubscription-Klasse bereit, die für das gewünschte Thema zurückgegeben wird und Informationen für Themenabonnements enthält.

Erweitern Sie den Quellcode 
class TopicSubscription:
    """
    NCache provides TopicSubscription class which is returned against the desired topic,containing information for
    topic subscriptions.
    """
    def __init__(self, value):
        self.__topicsubscription = value

    def get_instance(self):
        return self.__topicsubscription

    def set_instance(self, value):
        self.__topicsubscription = value

    def add_message_received_listener(self, messagereceivedlistener):
        """
        Event to register subscriber against the topic so that it can receive the published messages.

        :param messagereceivedlistener: The listener function that is invoked whenever a message is received. This
            function should follow this signature: message_received_listener(sender: object, args: MessageEventArgs)
        :type messagereceivedlistener: Callable
        """
        ValidateType.params_check(messagereceivedlistener, 2, self.add_message_received_listener)

        eventlistener = EventsListenerHelper.get_listener(messagereceivedlistener, MessageReceivedListener)
        self.__topicsubscription.addMessageReceivedListener(eventlistener)

    def get_topic(self):
        """
        Retrieves Topic instance containing information about the topic.

        :return: Topic instance of the topic.
        :rtype: Topic
        """
        result = self.__topicsubscription.getTopic()

        if result is not None:
            from ncache.runtime.caching.Topic import Topic
            return Topic(result)

    def remove_message_received_listener(self, messagereceivedlistener):
        """
        Unregisters the user for message received event.

        :param messagereceivedlistener: The registered message received listener function.
        :type messagereceivedlistener: Callable
        """
        ValidateType.params_check(messagereceivedlistener, 2, self.remove_message_received_listener)

        listener = EventsListenerHelper.get_listener(messagereceivedlistener, MessageReceivedListener)
        self.__topicsubscription.removeMessageReceivedListener(listener)

    def un_subscribe(self):
        """
        Unsubscribes the subscription to this topic.
        """
        self.__topicsubscription.unSubscribe()

Unterklassen

Methoden

def add_message_received_listener(self, messagereceivedlistener)

Ereignis zum Registrieren eines Abonnenten für das Thema, damit es die veröffentlichten Nachrichten empfangen kann.

:param messagereceivedlistener: Die Listener-Funktion, die immer dann aufgerufen wird, wenn eine Nachricht empfangen wird. Diese Funktion sollte dieser Signatur folgen: message_received_listener(sender: object, args: MessageEventArgs) :type messagereceivedlistener: Callable

Erweitern Sie den Quellcode 
def add_message_received_listener(self, messagereceivedlistener):
    """
    Event to register subscriber against the topic so that it can receive the published messages.

    :param messagereceivedlistener: The listener function that is invoked whenever a message is received. This
        function should follow this signature: message_received_listener(sender: object, args: MessageEventArgs)
    :type messagereceivedlistener: Callable
    """
    ValidateType.params_check(messagereceivedlistener, 2, self.add_message_received_listener)

    eventlistener = EventsListenerHelper.get_listener(messagereceivedlistener, MessageReceivedListener)
    self.__topicsubscription.addMessageReceivedListener(eventlistener)
def get_instance(self)
Erweitern Sie den Quellcode 
def get_instance(self):
    return self.__topicsubscription
def get_topic(self)

Ruft eine Topic-Instanz ab, die Informationen zum Thema enthält.

:return: Topic-Instanz des Themas. :rtype: Thema

Erweitern Sie den Quellcode 
def get_topic(self):
    """
    Retrieves Topic instance containing information about the topic.

    :return: Topic instance of the topic.
    :rtype: Topic
    """
    result = self.__topicsubscription.getTopic()

    if result is not None:
        from ncache.runtime.caching.Topic import Topic
        return Topic(result)
def remove_message_received_listener(self, messagereceivedlistener)

Hebt die Registrierung des Benutzers für das Ereignis „Nachricht empfangen“ auf.

:param messagereceivedlistener: Die registrierte Funktion zum Empfangen von Nachrichten. :type messagereceivedlistener: Aufrufbar

Erweitern Sie den Quellcode 
def remove_message_received_listener(self, messagereceivedlistener):
    """
    Unregisters the user for message received event.

    :param messagereceivedlistener: The registered message received listener function.
    :type messagereceivedlistener: Callable
    """
    ValidateType.params_check(messagereceivedlistener, 2, self.remove_message_received_listener)

    listener = EventsListenerHelper.get_listener(messagereceivedlistener, MessageReceivedListener)
    self.__topicsubscription.removeMessageReceivedListener(listener)
def set_instance(self, value)
Erweitern Sie den Quellcode 
def set_instance(self, value):
    self.__topicsubscription = value
def un_subscribe(self)

Abmelden des Abonnements für dieses Thema.

Erweitern Sie den Quellcode 
def un_subscribe(self):
    """
    Unsubscribes the subscription to this topic.
    """
    self.__topicsubscription.unSubscribe()