Android Open Source - RealtimeMessaging-Android Channel Subscription

• Back to Development/sdk  ↑

From Project

Back to project page RealtimeMessaging-Android.

License

The source code is released under:

MIT License

Java Source Code

/**
 * @fileoverview This file contains the class to create ortc factories
 * @author ORTC team members (ortc@ibt.pt) 
 *//*w w  w .ja  v a 2 s. c  o  m*/
package ibt.ortc.extensibility;

import java.util.HashMap;
import java.util.Map;

/**
 * Class that represents a channel subscription
 *  
 * How to use:
 * <pre>
 * subscribedChannel = new ChannelSubscription(subscribeOnReconnect, onMessageEventHandler);
 * </pre>
 * @version 2.1.0 27 Mar 2013
 * @author IBT
 * 
 */
public class ChannelSubscription {
  private boolean isSubscribing;
  private boolean isSubscribed;
  private boolean subscribeOnReconnected;
  private OnMessage onMessage;
  private OnMessageWithPayload onMessageWithPayload;
  private boolean isWithPayload;
  private boolean withNotification;
  
  /**
   * Creates an instance of a channel subscription
   * @param subscribeOnReconnected Indicates if the channel should be subscribe if a reconnect happens
   * @param onMessageT Event handler that is fired when a message is received in the channel
   * @param withNotification If true, GCM will be used
   */
  public <T> ChannelSubscription(boolean subscribeOnReconnected,T onMessageT, boolean withNotification){
    this.subscribeOnReconnected = subscribeOnReconnected;

    
    this.onMessageWithPayload = null;
    if(onMessageT instanceof OnMessage){
      this.onMessage = (OnMessage) onMessageT;
      this.isWithPayload = false;
    } else {
      this.onMessageWithPayload = (OnMessageWithPayload) onMessageT;
      this.isWithPayload = true;
    }
    this.isSubscribed = false;
    this.isSubscribing = false;
    this.withNotification = withNotification;
  }
  
  /**
   * Indicates whether the channel is being subscribed or not
   * @return boolean True if is subscribing the channel otherwise false
   */
  public boolean isSubscribing() {
    return isSubscribing;
  }

  /**
   * Changes the channel subscribing status
   * @param isSubscribing True indicates the channel is being subscribed
   */
  public void setSubscribing(boolean isSubscribing) {
    this.isSubscribing = isSubscribing;
  }

  /**
   * Indicates whether the channel is subscribed or not
   * @return boolean True if the channel is subscribed otherwise false
   */
  public boolean isSubscribed() {
    return isSubscribed;
  }

  /**
   * Changes the channel subscribed status
   * @param isSubscribed True indicates the channel is being subscribed
   */
  public void setSubscribed(boolean isSubscribed) {
    this.isSubscribed = isSubscribed;
  }

  /**
   * Fires the event handler that is associated the subscribed channel
   * @param channel 
   * @param sender
   * @param message 
   */
  public void runHandler(OrtcClient sender, String channel, String message){
    this.runHandler(sender, channel, message, null);
  }
  /**
   * Fires the event handler that is associated the subscribed channel (with payload)
   * @param channel 
   * @param sender
   * @param message 
   * @param payload
   */
  public void runHandler(OrtcClient sender, String channel, String message, Map<String, Object> payload){
    if(this.isWithPayload){
      this.onMessageWithPayload.run(sender, channel, message, payload);
    } else {
      this.onMessage.run(sender, channel, message);    
    }
  }
  
  /**
   * Indicates where the channel should be subscribed if a reconnect happens
   * @return boolean True if should be subscribed otherwise false
   */
  public boolean subscribeOnReconnected() {
    return subscribeOnReconnected;
  }
  
  /**
   * Indicates where the channel should be subscribed if a reconnect happens
   */
  public void setSubscribeOnReconnected(boolean value) {
    subscribeOnReconnected = value;
  }
  
  public boolean isWithNotification(){
    return this.withNotification;
  }
}

Java Source Code List

• Back to Development/sdk  ↑