Sccp conn flow control #242

sccp/sccp-api/src/main/java/org/mobicents/protocols/ss7/sccp/MaxConnectionCountReached.java

@@ -0,0 +1,10 @@
+package org.mobicents.protocols.ss7.sccp;
+
+public class MaxConnectionCountReached extends Exception {
+    public MaxConnectionCountReached() {
+    }
+
+    public MaxConnectionCountReached(String message) {
+        super(message);
+    }
+}

sccp/sccp-api/src/main/java/org/mobicents/protocols/ss7/sccp/SccpConnection.java

@@ -0,0 +1,44 @@
+package org.mobicents.protocols.ss7.sccp;
+
+import org.mobicents.protocols.ss7.sccp.message.SccpConnCrMessage;
+import org.mobicents.protocols.ss7.sccp.parameter.Credit;
+import org.mobicents.protocols.ss7.sccp.parameter.LocalReference;
+import org.mobicents.protocols.ss7.sccp.parameter.RefusalCause;
+import org.mobicents.protocols.ss7.sccp.parameter.ReleaseCause;
+import org.mobicents.protocols.ss7.sccp.parameter.ResetCause;
+import org.mobicents.protocols.ss7.sccp.parameter.SccpAddress;
+
+import java.io.IOException;
+
+public interface SccpConnection {
+    int getSls();
+    int getLocalSsn();
+
+    // source local reference
+    LocalReference getLocalReference();
+
+    // destination local reference
+    LocalReference getRemoteReference();
+
+    // not available after disconnect
+    boolean isAvailable();
+
+
+    void send(byte[] data) throws Exception;
+
+    SccpConnectionState getState();
+
+    // for protocol class 3 only
+    Credit getCredit();
+
+    void establish(SccpConnCrMessage message) throws IOException;
+
+    void reset(ResetCause reason) throws Exception;
+
+    void disconnect(RefusalCause reason, byte[] data) throws Exception;
+    void disconnect(ReleaseCause reason, byte[] data) throws Exception;
+
+    void confirm(SccpAddress respondingAddress) throws Exception;
+
+    SccpListener getListener();
+}

sccp/sccp-api/src/main/java/org/mobicents/protocols/ss7/sccp/SccpConnectionState.java

@@ -0,0 +1,5 @@
+package org.mobicents.protocols.ss7.sccp;
+
+public enum SccpConnectionState {
+    NEW, CR_SENT, CR_RECEIVED, ESTABLISHED, CLOSED, RSR_SENT, RSR_RECEIVED;
+}

sccp/sccp-api/src/main/java/org/mobicents/protocols/ss7/sccp/SccpListener.java

@@ -26,6 +26,13 @@
 
 import org.mobicents.protocols.ss7.sccp.message.SccpDataMessage;
 import org.mobicents.protocols.ss7.sccp.message.SccpNoticeMessage;
+import org.mobicents.protocols.ss7.sccp.parameter.Credit;
+import org.mobicents.protocols.ss7.sccp.parameter.Importance;
+import org.mobicents.protocols.ss7.sccp.parameter.ProtocolClass;
+import org.mobicents.protocols.ss7.sccp.parameter.RefusalCause;
+import org.mobicents.protocols.ss7.sccp.parameter.ReleaseCause;
+import org.mobicents.protocols.ss7.sccp.parameter.ResetCause;
+import org.mobicents.protocols.ss7.sccp.parameter.SccpAddress;
 
 /**
  *
@@ -86,4 +93,24 @@ public interface SccpListener extends Serializable {
      */
     void onNetworkIdState(int networkId, NetworkIdState networkIdState);
 
+
+    // N-CONNECT
+    // can call conn.confirm() or conn.disconnect(...) with refuse reason and data
+    void onConnectIndication(SccpConnection conn, SccpAddress calledAddress, SccpAddress callingAddress,
+                             ProtocolClass clazz, Credit credit, // QoS, credit is set only for class 3
+                             byte[] data, Importance importance) throws Exception;
+    // N-CONNECT
+    void onConnectConfirm(SccpConnection conn);
+
+    // N-DISCONNECT
+    void onDisconnectIndication(SccpConnection conn, ReleaseCause reason, byte[] data);
+    void onDisconnectIndication(SccpConnection conn, RefusalCause reason, byte[] data);
+
+    void onResetIndication(SccpConnection conn, ResetCause reason);
+
+    void onResetConfirm(SccpConnection conn);
+
+    void onData(SccpConnection conn, byte[] data);
+
+    void onDisconnectConfirm(SccpConnection conn);
 }

sccp/sccp-api/src/main/java/org/mobicents/protocols/ss7/sccp/SccpProvider.java

@@ -29,7 +29,9 @@
 
 import org.mobicents.protocols.ss7.sccp.message.MessageFactory;
 import org.mobicents.protocols.ss7.sccp.message.SccpDataMessage;
+import org.mobicents.protocols.ss7.sccp.parameter.LocalReference;
 import org.mobicents.protocols.ss7.sccp.parameter.ParameterFactory;
+import org.mobicents.protocols.ss7.sccp.parameter.ProtocolClass;
 import org.mobicents.protocols.ss7.sccp.parameter.SccpAddress;
 import org.mobicents.ss7.congestion.ExecutorCongestionMonitor;
 
@@ -109,4 +111,7 @@ public interface SccpProvider extends Serializable {
      */
     ExecutorCongestionMonitor[] getExecutorCongestionMonitorList();
 
+    SccpConnection newConnection(int localSsn, ProtocolClass protocolClass) throws MaxConnectionCountReached;
+
+    FastMap<LocalReference, SccpConnection> getConnections();
 }

sccp/sccp-api/src/main/java/org/mobicents/protocols/ss7/sccp/SccpStack.java

@@ -299,4 +299,5 @@ public interface SccpStack {
      */
     void setCongControl_blockingOutgoungSccpMessages(boolean value) throws Exception;
 
+
 }

sccp/sccp-api/src/main/java/org/mobicents/protocols/ss7/sccp/message/SccpConnAkMessage.java

@@ -31,7 +31,7 @@
  * This interface represents a SCCP data acknowledgement message for connection-oriented protocol class 3.
  *
  */
-public interface SccpConnAkMessage extends SccpMessage {
+public interface SccpConnAkMessage extends SccpConnMessage {
     LocalReference getDestinationLocalReferenceNumber();
     void setDestinationLocalReferenceNumber(LocalReference number);
 

sccp/sccp-api/src/main/java/org/mobicents/protocols/ss7/sccp/message/SccpConnCcMessage.java

@@ -33,7 +33,7 @@
  * This interface represents a SCCP connection confirm message for connection-oriented protocol classes 2 and 3.
  *
  */
-public interface SccpConnCcMessage extends SccpMessage {
+public interface SccpConnCcMessage extends SccpConnMessage {
     LocalReference getDestinationLocalReferenceNumber();
     void setDestinationLocalReferenceNumber(LocalReference number);
 

sccp/sccp-api/src/main/java/org/mobicents/protocols/ss7/sccp/message/SccpConnCrMessage.java

@@ -34,7 +34,7 @@
  * This interface represents a SCCP connection request message for connection-oriented protocol classes 2 and 3.
  *
  */
-public interface SccpConnCrMessage extends SccpMessage {
+public interface SccpConnCrMessage extends SccpConnMessage, SccpAddressedMessage {
 
     LocalReference getSourceLocalReferenceNumber();
     void setSourceLocalReferenceNumber(LocalReference number);
@@ -56,7 +56,10 @@ public interface SccpConnCrMessage extends SccpMessage {
 
     HopCounter getHopCounter();
     void setHopCounter(HopCounter counter);
+    boolean reduceHopCounter();
 
     Importance getImportance();
     void setImportance(Importance importance);
+
+    boolean getSccpCreatesSls();
 }

sccp/sccp-api/src/main/java/org/mobicents/protocols/ss7/sccp/message/SccpConnCrefMessage.java

@@ -32,7 +32,7 @@
  * This interface represents a SCCP connection refused message for connection-oriented protocol classes 2 and 3.
  *
  */
-public interface SccpConnCrefMessage extends SccpMessage {
+public interface SccpConnCrefMessage extends SccpConnMessage {
     LocalReference getDestinationLocalReferenceNumber();
     void setDestinationLocalReferenceNumber(LocalReference number);
 

sccp/sccp-api/src/main/java/org/mobicents/protocols/ss7/sccp/message/SccpConnDt1Message.java

@@ -30,7 +30,7 @@
  * This interface represents a SCCP data form 1 message for connection-oriented protocol class 2.
  *
  */
-public interface SccpConnDt1Message extends SccpMessage {
+public interface SccpConnDt1Message extends SccpConnMessage {
     LocalReference getDestinationLocalReferenceNumber();
     void setDestinationLocalReferenceNumber(LocalReference number);
 

sccp/sccp-api/src/main/java/org/mobicents/protocols/ss7/sccp/message/SccpConnDt2Message.java

@@ -30,7 +30,7 @@
  * This interface represents a SCCP data form 2 message for connection-oriented protocol class 3.
  *
  */
-public interface SccpConnDt2Message extends SccpMessage {
+public interface SccpConnDt2Message extends SccpConnMessage {
     LocalReference getDestinationLocalReferenceNumber();
     void setDestinationLocalReferenceNumber(LocalReference number);
 

sccp/sccp-api/src/main/java/org/mobicents/protocols/ss7/sccp/message/SccpConnErrMessage.java

@@ -30,7 +30,7 @@
  * This interface represents a SCCP protocol data unit error message for connection-oriented protocol classes 2 and 3.
  *
  */
-public interface SccpConnErrMessage extends SccpMessage {
+public interface SccpConnErrMessage extends SccpConnMessage {
     LocalReference getDestinationLocalReferenceNumber();
     void setDestinationLocalReferenceNumber(LocalReference number);
 

sccp/sccp-api/src/main/java/org/mobicents/protocols/ss7/sccp/message/SccpConnItMessage.java

@@ -32,7 +32,7 @@
  * This interface represents a SCCP inactivity test message for connection-oriented protocol classes 2 and 3.
  *
  */
-public interface SccpConnItMessage extends SccpMessage {
+public interface SccpConnItMessage extends SccpConnMessage {
     LocalReference getDestinationLocalReferenceNumber();
     void setDestinationLocalReferenceNumber(LocalReference number);
 

sccp/sccp-api/src/main/java/org/mobicents/protocols/ss7/sccp/message/SccpConnMessage.java

@@ -0,0 +1,9 @@
+package org.mobicents.protocols.ss7.sccp.message;
+
+/**
+ *
+ * This interface represents a SCCP connection-oriented protocol class message.
+ *
+ */
+public interface SccpConnMessage extends SccpMessage {
+}

sccp/sccp-api/src/main/java/org/mobicents/protocols/ss7/sccp/message/SccpConnRlcMessage.java

@@ -29,7 +29,7 @@
  * This interface represents a SCCP release complete message for connection-oriented protocol classes 2 and 3.
  *
  */
-public interface SccpConnRlcMessage extends SccpMessage {
+public interface SccpConnRlcMessage extends SccpConnMessage {
     LocalReference getDestinationLocalReferenceNumber();
     void setDestinationLocalReferenceNumber(LocalReference number);
 

sccp/sccp-api/src/main/java/org/mobicents/protocols/ss7/sccp/message/SccpConnRlsdMessage.java

@@ -31,7 +31,7 @@
  * This interface represents a SCCP released message for connection-oriented protocol classes 2 and 3.
  *
  */
-public interface SccpConnRlsdMessage extends SccpMessage {
+public interface SccpConnRlsdMessage extends SccpConnMessage {
     LocalReference getDestinationLocalReferenceNumber();
     void setDestinationLocalReferenceNumber(LocalReference number);
 

sccp/sccp-api/src/main/java/org/mobicents/protocols/ss7/sccp/message/SccpConnRscMessage.java

@@ -29,7 +29,7 @@
  * This interface represents a SCCP reset confirmation message for connection-oriented protocol class 3.
  *
  */
-public interface SccpConnRscMessage extends SccpMessage {
+public interface SccpConnRscMessage extends SccpConnMessage {
     LocalReference getDestinationLocalReferenceNumber();
     void setDestinationLocalReferenceNumber(LocalReference number);
 

sccp/sccp-api/src/main/java/org/mobicents/protocols/ss7/sccp/message/SccpConnRsrMessage.java

@@ -30,7 +30,7 @@
  * This interface represents a SCCP reset request message for connection-oriented protocol class 3.
  *
  */
-public interface SccpConnRsrMessage extends SccpMessage {
+public interface SccpConnRsrMessage extends SccpConnMessage {
     LocalReference getDestinationLocalReferenceNumber();
     void setDestinationLocalReferenceNumber(LocalReference number);