org.restcomm.protocols.ss7.tcap.api.TCAPStack Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tcap-api Show documentation
There is a newer version: 10.0.36
/*
 * Mobius Software LTD
 * Copyright 2019, Mobius Software LTD and individual contributors
 * by the @authors tag.
 *
 * This program is free software: you can redistribute it and/or modify
 * under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation; either version 3 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see 
 */

package org.restcomm.protocols.ss7.tcap.api;

import java.util.Collection;
import java.util.List;
import java.util.Map;

import org.restcomm.protocols.ss7.sccp.SccpStack;

/**
 * @author baranowb
 * @author yulianoifa
 */
public interface TCAPStack {

	// default value of idle timeout and after TC_END remove of task.
    public static final long _DIALOG_TIMEOUT = 60000;
    public static final long _INVOKE_TIMEOUT = 30000;

    public static final long _EMPTY_INVOKE_TIMEOUT = -1;
    
    /**
     * Returns the name of this stack
     * @return
     */
    String getName();

    /**
     * Returns stack provider.
     * @return
     */
    TCAPProvider getProvider();

    /**
     * Stops this stack and transport layer(SCCP)
     */
    void stop();

    /**
     * Start stack and transport layer(SCCP)
     *
     * @throws IllegalStateException - if stack is already running or not configured
     * @throws StartFailedException
     */
    void start() throws Exception;

    boolean isStarted();

    /**
     * Sets millisecond value for dialog timeout. It specifies how long dialog can be idle - not receive/send any messages.
     *
     * @param l
     */
    void setDialogIdleTimeout(long l) throws Exception;

    long getDialogIdleTimeout();

    /**
     * Sets the Invoke timeout for this invoke. Peer should respond back within invoke timeout, else stack will callback
     * {@link TCListener#onInvokeTimeout(org.restcomm.protocols.ss7.tcap.asn.comp.Invoke)} for application to take corrective
     * action. InvokeTimeout should always be less than DialogIdleTimeout.
     *
     * @param v
     */
    void setInvokeTimeout(long v) throws Exception;

    long getInvokeTimeout();

    /**
     * Sets the start of the range of the generated dialog ids.
     */
    void setDialogIdRangeStart(long val) throws Exception;

    /**
     * Sets the end of the range of the generated dialog ids.
     */
    void setDialogIdRangeEnd(long val) throws Exception;

    /**
     *
     * @return starting dialog id within the range
     */
    long getDialogIdRangeStart();

    /**
     *
     * @return ending dialog id within the range
     */
    long getDialogIdRangeEnd();    

    void setExtraSsns(List extraSsnsNew) throws Exception;

    Collection getExtraSsns();

    boolean isExtraSsnPresent(int ssn);

    String getSubSystemNumberList();

    void setDoNotSendProtocolVersion(boolean val) throws Exception;

    boolean getDoNotSendProtocolVersion();

    /**
     * Returns the Sub System Number (SSN) that this TCAP Stack is registered for
     *
     * @return
     */
    int getSubSystemNumber();

    /** Set value for slsRange for this TCAP Stack.
     *
     * @param val
     */
    void setSlsRange(String val) throws Exception;

    /**
     * Returns the SlsRange that this TCAP Stack is registered for
     *
     * @return
     */
    String getSlsRange();

    /**
     * Returns the SCCP stack
     *
     * @return
     */
    SccpStack getSccpStack();

    /**
     * Returns the SCCP stack
     *
     * @return
     */
    boolean getSwapTcapIdBytes();

    /**
     * Set is there need to swap bytes for Txid
     *
     * @return
     */
    void setSwapTcapIdBytes(boolean isSwapTcapIdBytes);
    
    Map getComponentsSentByType();
    
    Map getComponentsReceivedByType();
    
    Map getMessagesSentByType();
    
    Map getMessagesReceivedByType();
    
    Map getRejectsSentByType();
    
    Map getRejectsReceivedByType();
    
    Map getAbortsSentByType();
    
    Map getAbortsReceivedByType();
    
    Long getIncomingDialogsProcessed();
    
    Long getOutgoingDialogsProcessed();
    
    Long getBytesSent();
    
    Long getBytesReceived();
    
    Long getDialogTimeoutProcessed();

	Long getInvokeTimeoutProcessed();
	
	Map getComponentsSentByTypeAndNetwork(Integer networkID);
    
    Map getComponentsReceivedByTypeAndNetwork(Integer networkID);
    
    Map getMessagesSentByTypeAndNetwork(Integer networkID);
    
    Map getMessagesReceivedByTypeAndNetwork(Integer networkID);
    
    Map getRejectsSentByTypeAndNetwork(Integer networkID);
    
    Map getRejectsReceivedByTypeAndNetwork(Integer networkID);
    
    Map getAbortsSentByTypeAndNetwork(Integer networkID);
    
    Map getAbortsReceivedByTypeAndNetwork(Integer networkID);
    
    Long getIncomingDialogsProcessedByNetwork(Integer networkID);
    
    Long getOutgoingDialogsProcessedByNetwork(Integer networkID);
    
    Long getBytesSentByNetwork(Integer networkID);
    
    Long getBytesReceivedByNetwork(Integer networkID);
    
    Long getDialogTimeoutProcessedByNetwork(Integer networkID);

	Long getInvokeTimeoutProcessedByNetwork(Integer networkID);
}