UdpConnection (SteamKit dev-SNAPSHOT API)

java.lang.Object
- uk.co.thomasc.steamkit.networking.steam3.Connection
- - uk.co.thomasc.steamkit.networking.steam3.UdpConnection

public class UdpConnection
extends Connection

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

(package private) class UdpConnection.NetLoop

Nested Classes
Modifier and Type	Class and Description
`(package private) class`	`UdpConnection.NetLoop`

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`AHEAD_COUNT` Maximum number of packets that we can be waiting on at a time.
`private Map<Integer,UdpPacket>`	`inPackets`
`private int`	`inSeq` The sequence number we plan on acknowledging receiving with the next Ack.
`private int`	`inSeqAcked` The highest sequence number we've acknowledged receiving.
`private int`	`inSeqHandled` The highest sequence number we've processed.
`private Thread`	`netThread`
`private Date`	`nextResend`
`private List<UdpPacket>`	`outPackets`
`private int`	`outSeq` The next outgoing sequence number to be used.
`private int`	`outSeqAcked` The sequence number of the highest packet acknowledged by the server.
`private int`	`outSeqSent` The highest sequence number of an outbound packet that has been sent.
`private int`	`remoteConnId`
`private IPEndPoint`	`remoteEndPoint`
`private int`	`RESEND_COUNT` Maximum number of packets to resend when RESEND_DELAY is exceeded.
`private int`	`RESEND_DELAY` Seconds to wait before sending packets.
`private DatagramSocket`	`sock`
`private int`	`sourceConnId`
`private UdpState`	`state` Contains information about the state of the connection, used to filter out packets that are unexpected or not valid given the state of the connection.
`private Date`	`timeOut`
`private int`	`TIMEOUT_DELAY` Seconds to wait before considering the connection dead.

Fields inherited from class uk.co.thomasc.steamkit.networking.steam3.Connection
connected, disconnected, netFilter, netMsgReceived

Constructor Summary

Constructors
Constructor and Description

UdpConnection()

Constructors
Constructor and Description
`UdpConnection()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`connect(IPEndPoint endPoint)` Connects to the specified CM server.
`void`	`disconnect()` Disconnects this instance, blocking until the queue of messages is empty or the connection is otherwise terminated.
`private boolean`	`dispatchMessage()` Dispatches up to one message to the rest of SteamKit
`InetAddress`	`getLocalIP()` Gets the local IP.
`private int`	`readyMessageParts()` Returns the number of message parts in the next message.
`private void`	`receiveAccept(UdpPacket packet)` Receives the notification of an accepted connection and sets the connection id that will be used for the connection's duration.
`private void`	`receiveChallenge(UdpPacket packet)` Receives the challenge and responds with a Connect request
`private void`	`receiveData(UdpPacket packet)` Receives typical data packets before dispatching them for consumption by the rest of SteamKit
`private void`	`receivePacket(UdpPacket packet)` Receives the packet, performs all sanity checks and then passes it along as necessary.
`void`	`send(IClientMsg clientMsg)` Serializes and sends the provided message to the server in as many packets as is necessary.
`private void`	`sendAck()` Sends a datagram Ack, used when an Ack needs to be sent but there is no data response to piggy-back on.
`private void`	`sendData(BinaryReader ms)` Sends the data sequenced as a single message, splitting it into multiple parts if necessary.
`private void`	`sendPacket(UdpPacket packet)` Sends a packet immediately.
`private void`	`sendPendingMessages()` Sends or resends sequenced messages, if necessary.
`private void`	`sendSequenced(UdpPacket packet)` Sends the packet as a sequenced, reliable packet.
`private void`	`sendSequenced(UdpPacket[] packets)` Sends the packets as one sequenced, reliable net message.

Methods inherited from class uk.co.thomasc.steamkit.networking.steam3.Connection
onConnected, onDisconnected, onNetMsgReceived

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

- Field Detail
  - RESEND_DELAY
```
private final int RESEND_DELAY
```
    Seconds to wait before sending packets.
    
    See Also:
    Constant Field Values
  - TIMEOUT_DELAY
```
private final int TIMEOUT_DELAY
```
    Seconds to wait before considering the connection dead.
    
    See Also:
    Constant Field Values
  - RESEND_COUNT
```
private final int RESEND_COUNT
```
    Maximum number of packets to resend when RESEND_DELAY is exceeded.
    
    See Also:
    Constant Field Values
  - AHEAD_COUNT
```
private final int AHEAD_COUNT
```
    Maximum number of packets that we can be waiting on at a time.
    
    See Also:
    Constant Field Values
  - state
```
private UdpState state
```
    Contains information about the state of the connection, used to filter out packets that are unexpected or not valid given the state of the connection.
  - netThread
```
private Thread netThread
```
  - sock
```
private DatagramSocket sock
```
  - remoteEndPoint
```
private IPEndPoint remoteEndPoint
```
  - timeOut
```
private Date timeOut
```
  - nextResend
```
private Date nextResend
```
  - sourceConnId
```
private int sourceConnId
```
  - remoteConnId
```
private int remoteConnId
```
  - outSeq
```
private int outSeq
```
    The next outgoing sequence number to be used.
  - outSeqSent
```
private int outSeqSent
```
    The highest sequence number of an outbound packet that has been sent.
  - outSeqAcked
```
private int outSeqAcked
```
    The sequence number of the highest packet acknowledged by the server.
  - inSeq
```
private int inSeq
```
    The sequence number we plan on acknowledging receiving with the next Ack. All packets below or equal to inSeq *must* have been received, but not necessarily handled.
  - inSeqAcked
```
private int inSeqAcked
```
    The highest sequence number we've acknowledged receiving.
  - inSeqHandled
```
private int inSeqHandled
```
    The highest sequence number we've processed.
  - outPackets
```
private List<UdpPacket> outPackets
```
  - inPackets
```
private Map<Integer,UdpPacket> inPackets
```
- Constructor Detail
  - UdpConnection
```
public UdpConnection()
```
- Method Detail
  - connect
```
public void connect(IPEndPoint endPoint)
```
    Connects to the specified CM server.
    
    Specified by:
    
    connect in class Connection
    
    Parameters:
    endPoint - The CM server.
  - disconnect
```
public void disconnect()
```
    Disconnects this instance, blocking until the queue of messages is empty or the connection is otherwise terminated.
    
    Specified by:
    
    disconnect in class Connection
  - send
```
public void send(IClientMsg clientMsg)
```
    Serializes and sends the provided message to the server in as many packets as is necessary.
    
    Specified by:
    
    send in class Connection
    
    Parameters:
    clientMsg - The ClientMsg
  - sendData
```
private void sendData(BinaryReader ms)
```
    Sends the data sequenced as a single message, splitting it into multiple parts if necessary.
    
    Parameters:
    ms - The data to send.
  - sendSequenced
```
private void sendSequenced(UdpPacket packet)
```
    Sends the packet as a sequenced, reliable packet.
    
    Parameters:
    packet - The packet.
  - sendSequenced
```
private void sendSequenced(UdpPacket[] packets)
```
    Sends the packets as one sequenced, reliable net message.
    
    Parameters:
    packets - The packets that make up the single net message
  - sendPacket
```
private void sendPacket(UdpPacket packet)
```
    Sends a packet immediately.
    
    Parameters:
    packet - The packet.
  - sendAck
```
private void sendAck()
```
    Sends a datagram Ack, used when an Ack needs to be sent but there is no data response to piggy-back on.
  - sendPendingMessages
```
private void sendPendingMessages()
```
    Sends or resends sequenced messages, if necessary. Also responsible for throttling the rate at which they are sent.
  - readyMessageParts
```
private int readyMessageParts()
```
    Returns the number of message parts in the next message.
    
    Returns:
    Non-zero number of message parts if a message is ready to be handled, 0 otherwise
  - dispatchMessage
```
private boolean dispatchMessage()
```
    Dispatches up to one message to the rest of SteamKit
    
    Returns:
    True if a message was dispatched, false otherwise
  - receivePacket
```
private void receivePacket(UdpPacket packet)
```
    Receives the packet, performs all sanity checks and then passes it along as necessary.
    
    Parameters:
    packet - The packet.
  - receiveChallenge
```
private void receiveChallenge(UdpPacket packet)
```
    Receives the challenge and responds with a Connect request
    
    Parameters:
    packet - The packet.
  - receiveAccept
```
private void receiveAccept(UdpPacket packet)
```
    Receives the notification of an accepted connection and sets the connection id that will be used for the connection's duration.
    
    Parameters:
    packet -
  - receiveData
```
private void receiveData(UdpPacket packet)
```
    Receives typical data packets before dispatching them for consumption by the rest of SteamKit
    
    Parameters:
    packet - The packet.
  - getLocalIP
```
public InetAddress getLocalIP()
```
    Description copied from class: Connection
    
    Gets the local IP.
    
    Specified by:
    
    getLocalIP in class Connection
    
    Returns:
    The local IP

Class UdpConnection

Nested Class Summary

Field Summary

Fields inherited from class uk.co.thomasc.steamkit.networking.steam3.Connection

Constructor Summary

Method Summary

Methods inherited from class uk.co.thomasc.steamkit.networking.steam3.Connection

Methods inherited from class java.lang.Object

Field Detail

RESEND_DELAY

TIMEOUT_DELAY

RESEND_COUNT

AHEAD_COUNT

state

netThread

sock

remoteEndPoint

timeOut

nextResend

sourceConnId

remoteConnId

outSeq

outSeqSent

outSeqAcked

inSeq

inSeqAcked

inSeqHandled

outPackets

inPackets

Constructor Detail

UdpConnection

Method Detail

connect

disconnect

send

sendData

sendSequenced

sendSequenced

sendPacket

sendAck

sendPendingMessages

readyMessageParts

dispatchMessage

receivePacket

receiveChallenge

receiveAccept

receiveData

getLocalIP