liblttng-ust-java-agent/java/lttng-ust-agent-common/org/lttng/ust/agent/client/ILttngTcpClientListener.java

   1 /*
   2  * Copyright (C) 2015 - EfficiOS Inc., Alexandre Montplaisir <alexmonthy@efficios.com>
   3  *
   4  * This library is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU Lesser General Public License, version 2.1 only,
   6  * as published by the Free Software Foundation.
   7  *
   8  * This library is distributed in the hope that it will be useful, but WITHOUT
   9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
  11  * for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public License
  14  * along with this library; if not, write to the Free Software Foundation,
  15  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  16  */
  17
  18 package org.lttng.ust.agent.client;
  19
  20 import org.lttng.ust.agent.session.EventRule;
  21
  22 /**
  23  * TCP client listener interface.
  24  *
  25  * This interface contains callbacks that are called when the TCP client
  26  * receives commands from the session daemon. These callbacks will define what
  27  * do to with each command.
  28  *
  29  * @author Alexandre Montplaisir
  30  */
  31 public interface ILttngTcpClientListener {
  32
  33         /**
  34          * Callback for the TCP client to notify the listener agent that a request
  35          * for enabling an event rule was sent from the session daemon.
  36          *
  37          * @param eventRule
  38          *            The event rule that was requested to be enabled
  39          * @return Since we do not track individual sessions, right now this command
  40          *         cannot fail. It will always return true.
  41          */
  42         boolean eventEnabled(EventRule eventRule);
  43
  44         /**
  45          * Callback for the TCP client to notify the listener agent that a request
  46          * for disabling an event was sent from the session daemon.
  47          *
  48          * @param eventName
  49          *            The name of the event that was requested to be disabled.
  50          * @return True if the command completed successfully, false if we should
  51          *         report an error (event was not enabled, etc.)
  52          */
  53         boolean eventDisabled(String eventName);
  54
  55         /**
  56          * List the all events currently enabled in the current tracing sessions.
  57          *
  58          * @return The list of enabled events
  59          */
  60         Iterable<String> listEnabledEvents();
  61 }