org.cricketmsf.out.queue.QueueIface Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2019 Grzegorz Skorupa .
 * 
 * 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 org.cricketmsf.out.queue;

import org.cricketmsf.exception.QueueException;
import org.cricketmsf.in.queue.QueueCallbackIface;

/**
 *
 * @author greg
 */
public interface QueueIface {
    
    public static int NOTIFY_NONE = 0;
    public static int NOTIFY_FIRST = 1;
    public static int NOTIFY_ALL = 2;
    
    /**
     * Adds object to specified channel overwriting object with the same key (if exists)
     * @param channel channel name
     * @param key key
     * @param value value
     * @throws QueueException exception
     */
    public void add(String channel, String key, Object value) throws QueueException;
    /**
     * Gets object of the required key from the channel without removing it from the channel
     * @param channel channel name
     * @param key object key
     * @return object
     * @throws QueueException 
     */
    public Object show(String channel, String key) throws QueueException;
    /**
     * Gets object of the required key from the channel
     * @param channel channel name
     * @param key object key
     * @return object
     * @throws QueueException 
     */
    public Object get(String channel, String key) throws QueueException;
    
    
    /**
     * Adds new object to the channel as the last element
     * @param channel channel name
     * @param value object to addd
     * @throws QueueException exception
     */
    public void push(String channel, Object value) throws QueueException;
    /**
     * Get the first object from the channel but not remove it
     * @param channel channel name
     * @return first object on the channel's list of objects
     * @throws QueueException exception
     */
    public Object show(String channel) throws QueueException;
    public Object pop(String channel) throws QueueException;
    
    
    public void subscribe(String channel, QueueCallbackIface callback) throws QueueException;
    public void unsubscribe(String channel, QueueCallbackIface callback) throws QueueException;
    public void purge(String channel) throws QueueException;
    public long getSize(String channel) throws QueueException;
    public long getSize() throws QueueException;
    public void setSubscribtionMode(int newMode) throws QueueException;
    public int getSubscribtionMode();
}