View Javadoc
1   /**
2    * Logback: the reliable, generic, fast and flexible logging framework.
3    * Copyright (C) 1999-2015, QOS.ch. All rights reserved.
4    *
5    * This program and the accompanying materials are dual-licensed under
6    * either the terms of the Eclipse Public License v1.0 as published by
7    * the Eclipse Foundation
8    *
9    *   or (per the licensee's choosing)
10   *
11   * under the terms of the GNU Lesser General Public License version 2.1
12   * as published by the Free Software Foundation.
13   */
14  package ch.qos.logback.core.net.server;
15  
16  import java.io.Serializable;
17  import java.util.concurrent.BlockingQueue;
18  
19  import ch.qos.logback.core.spi.ContextAware;
20  
21  /**
22   * A client of a {@link ServerRunner} that receives events from a local
23   * appender and logs them according to local policy.
24   *
25   * @author Carl Harris
26   */
27  interface RemoteReceiverClient extends Client, ContextAware {
28  
29      /**
30       * Sets the client's event queue.
31       * <p>
32       * This method must be invoked before the {@link #run()} method is invoked.
33       * @param queue the queue to set
34       */
35      void setQueue(BlockingQueue<Serializable> queue);
36  
37      /**
38       * Offers an event to the client.
39       * @param event the subject event
40       * @return {@code true} if the client's queue accepted the event,
41       *    {@code false} if the client's queue is full
42       */
43      boolean offer(Serializable event);
44  
45  }