ConnState

java.lang.Object
- org.ka2ddo.ax25.ConnState

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, AX25FrameSource
```
public class ConnState
extends java.lang.Object
implements AX25FrameSource, java.io.Closeable
```
This class keeps track of the state of one AX.25 connection-oriented session.

Author:

Andrew Pavlin, KA2DDO

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConnState.ConnTransition` Enum identifying the transitional condition of the connection.
`static class`	`ConnState.ConnType` Enumeration specifying the different types of connection-oriented AX.25 sessions.

Field Summary

Fields
Modifier and Type	Field and Description
`AX25Callsign`	`dst` Recipient of session.
`ConnectionEstablishmentListener`	`listener` Listener to be asynchronously informed of state changes in the session.
`java.lang.Object`	`sessionIdentifier` Arbitrary identifier for a particular connected-mode session.
`AX25Callsign`	`src` Originator of session.
`ConnState.ConnTransition`	`transition` The current state of this session.
`AX25Callsign[]`	`via` Digipeater path to use for transmitting from source to destination station.

Fields inherited from interface org.ka2ddo.ax25.AX25FrameSource
NO_FRAMES

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearResendableFrame()` Cancel an outstanding resendable frame's timer.
`void`	`close()` Closes this connection and releases any system resources associated with it.
`Connector`	`getConnector()` Report the Connector this message should be transmitted through.
`ConnState.ConnType`	`getConnType()` Get the connection windowing type.
`AX25Callsign`	`getDst()` Get the callsign of the station that received this connection session.
`AX25Frame[]`	`getFrames(boolean incrementXmtCount, ProtocolFamily protocolId, java.lang.String senderCallsign)` Get one or more AX25Frames of the data to transmit.
`java.io.InputStream`	`getInputStream()` Get a Java-style InputStream associated with this connection.
`long`	`getLastUpdateInSession()` Report the last time this connected-mode session was updated.
`int`	`getNumTransmitsBeforeDecay()` Get number of times frame will be retransmitted before inter-packet delay is increased.
`java.io.OutputStream`	`getOutputStream()` Get a Java-style OutputStream for writing to this connection.
`AX25Callsign`	`getSrc()` Get the callsign of the station that originated this connection session.
`java.lang.String`	`getStateOfConn()` Provide textual description of connection state.
`boolean`	`isOpen()` Get the current state of this connection.
`void`	`setConnector(TransmittingConnector connector)` Set the Connector through which frames for this connected-mode session should be transmitted.
`void`	`setConnType(ConnState.ConnType connType)` Set the connection windowing type.
`void`	`setResendableFrame(AX25Frame frame, int retryCount)` Specify that this transmitted unconnected frame needs a timeout timer in case the appropriate response does not come back.
`java.lang.String`	`toString()` Returns a string representation of the object.
`void`	`updateSessionTime()` Update the last-updated timestamp of this session.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - src
```
public final AX25Callsign src
```
    Originator of session.
  - dst
```
public final AX25Callsign dst
```
    Recipient of session.
  - transition
```
public ConnState.ConnTransition transition
```
    The current state of this session.
  - via
```
public AX25Callsign[] via
```
    Digipeater path to use for transmitting from source to destination station. Only meaningful when source is the local station.
  - listener
```
public ConnectionEstablishmentListener listener
```
    Listener to be asynchronously informed of state changes in the session.
  - sessionIdentifier
```
public java.lang.Object sessionIdentifier
```
    Arbitrary identifier for a particular connected-mode session.
- Method Detail
  - isOpen
```
public boolean isOpen()
```
    Get the current state of this connection.
    
    Returns:
    
    boolean true if connection is up and operating
  - getConnType
```
public ConnState.ConnType getConnType()
```
    Get the connection windowing type.
    
    Returns:
    
    ConnType enum describing the sliding window mode
  - setConnType
```
public void setConnType(ConnState.ConnType connType)
```
    Set the connection windowing type.
    
    Parameters:
    
    connType - ConnType enum describing the sliding window mode
  - getInputStream
```
public java.io.InputStream getInputStream()
                                   throws java.io.IOException
```
    Get a Java-style InputStream associated with this connection.
    
    Returns:
    
    InputStream for the connection
    
    Throws:
    
    java.io.IOException - if session not to or from this station
  - getOutputStream
```
public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException
```
    Get a Java-style OutputStream for writing to this connection.
    
    Returns:
    
    OutputStream to this connection
    
    Throws:
    
    java.io.IOException - if session not to or from this station
  - getSrc
```
public AX25Callsign getSrc()
```
    Get the callsign of the station that originated this connection session.
    
    Returns:
    
    AX25Callsign of originating station
  - getDst
```
public AX25Callsign getDst()
```
    Get the callsign of the station that received this connection session.
    
    Returns:
    
    AX25Callsign of receiving station
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of the object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a string representation of the object.
  - getStateOfConn
```
public java.lang.String getStateOfConn()
```
    Provide textual description of connection state.
    
    Returns:
    
    String connection state text
  - setResendableFrame
```
public void setResendableFrame(AX25Frame frame,
                               int retryCount)
```
    Specify that this transmitted unconnected frame needs a timeout timer in case the appropriate response does not come back.
    
    Parameters:
    
    frame - AX25Frame that was transmitted and is expecting a response
    
    retryCount - int number of times this frame should be retried before giving up on a response and failing whatever condition the frame was trying to set up
  - clearResendableFrame
```
public void clearResendableFrame()
```
    Cancel an outstanding resendable frame's timer. This is due to either receiving a valid response for the frame, or timing out for the last retry attempt and giving up.
  - getFrames
```
public AX25Frame[] getFrames(boolean incrementXmtCount,
                             ProtocolFamily protocolId,
                             java.lang.String senderCallsign)
```
    Get one or more AX25Frames of the data to transmit. Note this should only be used for AX.25 connections with one end terminated at the local station; Man-In-The-Middle (MitM) attacks are not friendly behavior.
    
    Specified by:
    
    getFrames in interface AX25FrameSource
    
    Parameters:
    
    incrementXmtCount - indicate whether the transmit counter (used to cycle through proportional pathing) should be incremented
    
    protocolId - indicate the protocol to generate this frame for
    
    senderCallsign - String of local callsign sending this message (may be ignored if digipeating a message from another station)
    
    Returns:
    
    array of AX25Frame objects to transmit (may be zero-length)
  - getNumTransmitsBeforeDecay
```
public int getNumTransmitsBeforeDecay()
```
    Get number of times frame will be retransmitted before inter-packet delay is increased.
    
    Specified by:
    
    getNumTransmitsBeforeDecay in interface AX25FrameSource
    
    Returns:
    
    transmission count before interval increase
  - getConnector
```
public Connector getConnector()
```
    Report the Connector this message should be transmitted through.
    
    Specified by:
    
    getConnector in interface AX25FrameSource
    
    Returns:
    
    a specific Connector instance to transmit through, or null for all applicable ports (Connector.CAP_XMT_PACKET_DATA and not rejecting this specific packet [such as IGateConnectors shouldn't re-transmit something received from the IGate])
    
    See Also:
    
    Connector.CAP_XMT_PACKET_DATA
  - setConnector
```
public void setConnector(TransmittingConnector connector)
```
    Set the Connector through which frames for this connected-mode session should be transmitted.
    
    Parameters:
    
    connector - Connector that is capable of transmitting AX.25 frames
  - close
```
public void close()
```
    Closes this connection and releases any system resources associated with it. If the connection is already closed then invoking this method has no effect.
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
  - getLastUpdateInSession
```
public long getLastUpdateInSession()
```
    Report the last time this connected-mode session was updated.
    
    Returns:
    
    time (in milliseconds since epoch) of the last update to this session
  - updateSessionTime
```
public void updateSessionTime()
```
    Update the last-updated timestamp of this session.

Class ConnState

Nested Class Summary

Field Summary

Fields inherited from interface org.ka2ddo.ax25.AX25FrameSource

Method Summary

Methods inherited from class java.lang.Object

Field Detail

src

dst

transition

via

listener

sessionIdentifier

Method Detail

isOpen

getConnType

setConnType

getInputStream

getOutputStream

getSrc

getDst

toString

getStateOfConn

setResendableFrame

clearResendableFrame

getFrames

getNumTransmitsBeforeDecay

getConnector

setConnector

close

getLastUpdateInSession

updateSessionTime