uk.co.thomasc.steamkit.networking.steam3

Class Connection

java.lang.Object

uk.co.thomasc.steamkit.networking.steam3.Connection

Direct Known Subclasses:

TcpConnection, UdpConnection

public abstract class Connection
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
GenericEvent	connected Occurs when the physical connection is established.
GenericEvent	disconnected Occurs when the physical connection is broken.
NetFilterEncryption	netFilter The net filter.
Event<NetMsgEventArgs>	netMsgReceived Occurs when a net message is recieved over the network.

Constructor Summary

Constructors

Constructor and Description
Connection()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	connect(IPEndPoint endPoint) Connects to the specified end point.
abstract void	disconnect() Disconnects this instance.
abstract InetAddress	getLocalIP() Gets the local IP.
protected void	onConnected(EventArgs e)
protected void	onDisconnected(EventArgs e)
protected void	onNetMsgReceived(NetMsgEventArgs e) Raises the netMsgReceived event.
abstract void	send(IClientMsg clientMsg) Sends the specified client net message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

netFilter

public NetFilterEncryption netFilter

The net filter.

netMsgReceived

public Event<NetMsgEventArgs> netMsgReceived

Occurs when a net message is recieved over the network.

connected

public GenericEvent connected

Occurs when the physical connection is established.

disconnected

public GenericEvent disconnected

Occurs when the physical connection is broken.

Constructor Detail

Connection

public Connection()

Method Detail

onNetMsgReceived

protected void onNetMsgReceived(NetMsgEventArgs e)

Raises the netMsgReceived event.

Parameters:

e - The NetMsgEventArgs instance containing the event data.

onConnected

protected void onConnected(EventArgs e)

onDisconnected

protected void onDisconnected(EventArgs e)

connect

public abstract void connect(IPEndPoint endPoint)

Connects to the specified end point.

Parameters:

endPoint - The end point.

disconnect

public abstract void disconnect()

Disconnects this instance.

send

public abstract void send(IClientMsg clientMsg)
                   throws IOException

Sends the specified client net message.

Parameters:

clientMsg - The client net message.

Throws:

IOException

getLocalIP

public abstract InetAddress getLocalIP()

Gets the local IP.

Returns:

The local IP