com.goodow.realtime.channel.Bus Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of realtime-channel Show documentation
The newest version!
/*
 * Copyright 2013 Goodow.com
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package com.goodow.realtime.channel;

import com.goodow.realtime.core.Handler;
import com.goodow.realtime.core.HandlerRegistration;

public interface Bus {
  String LOCAL = "@";
  String LOCAL_ON_OPEN = LOCAL + "goodow.bus.onOpen";
  String LOCAL_ON_CLOSE = LOCAL + "goodow.bus.onClose";
  String LOCAL_ON_ERROR = LOCAL + "goodow.bus.onError";

  /**
   * Close the EventBus and release all resources.
   */
  void close();

  State getReadyState();

  /**
   * Publish a message
   * 
   * @param address The address to publish it to
   * @param msg The message
   */
  Bus publish(String address, Object msg);

  /**
   * Registers a handler against the specified address
   * 
   * @param address The address to register it at
   * @param handler The handler
   * @return the handler registration, can be stored in order to unregister the handler later
   */
  @SuppressWarnings("rawtypes")
  HandlerRegistration registerHandler(String address, Handler handler);

  /**
   * Send a message
   * 
   * @param address The address to send it to
   * @param msg The message
   * @param replyHandler Reply handler will be called when any reply from the recipient is received
   */
   Bus send(String address, Object msg, Handler> replyHandler);
}