Package alexiil.mc.lib.net

Class NetIdData

java.lang.Object

alexiil.mc.lib.net.TreeNetIdBase

alexiil.mc.lib.net.NetIdBase

alexiil.mc.lib.net.NetIdSeparate

alexiil.mc.lib.net.NetIdData

public final class NetIdData
extends NetIdSeparate

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NetIdData.IMsgDataReceiver
static interface	NetIdData.IMsgDataWriter

Field Summary

Fields inherited from class alexiil.mc.lib.net.NetIdBase

DEFAULT_FLAGS, MAXIMUM_PRIORITY

Fields inherited from class alexiil.mc.lib.net.TreeNetIdBase

DYNAMIC_LENGTH, fullName, length, name, parent, totalLength

Constructor Summary

Constructors

Constructor	Description
NetIdData(ParentNetId parent, java.lang.String name, int length)

Method Summary

Modifier and Type	Method	Description
void	send(ActiveConnection connection)	Sends this signal over the specified connection
void	send(ActiveConnection connection, NetIdData.IMsgDataWriter writer)
NetIdData	setReadWrite(NetIdData.IMsgDataReceiver receiver, NetIdData.IMsgDataWriter writer)
NetIdData	setReceiver(NetIdData.IMsgDataReceiver receiver)
NetIdData	toClientOnly()	Changes the flags for this packet to indicate that it should only be sent from the server to the client.
NetIdData	toEitherSide()	This clears the NetIdBase.toClientOnly() and NetIdBase.toServerOnly() flag states, and will make sending packets not throw exceptions.
NetIdData	toServerOnly()	Changes the flags for this packet to indicate that it should only be sent from the client to the server.
NetIdData	withLargeSize()	Changes the size flags of this net ID to indicate that it should use three bytes for the packet's total length (including the header).
NetIdData	withNormalSize()	Changes the size flags of this net ID to indicate that it should use two bytes for the packet's total length (including the header).
NetIdData	withoutBuffering()	Changes the flags for this packet to indicate that it should never be buffered by a BufferedConnection.
NetIdData	withTinySize()	Changes the size flags of this net ID to indicate that it should use a single byte for the packet's total length (including the header).

Methods inherited from class alexiil.mc.lib.net.NetIdBase

_toClientOnly, _toEitherSide, _toServerOnly, buffered, changeFlag, notBuffered, setBuffered, setLargeSize, setMaximumDropDelay, setNormalSize, setTinySize

Methods inherited from class alexiil.mc.lib.net.TreeNetIdBase

equals, getPrintableName, getRealClassName, hasFixedLength, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

NetIdData

public NetIdData(ParentNetId parent, java.lang.String name, int length)

Method Details

setReceiver

public NetIdData setReceiver(NetIdData.IMsgDataReceiver receiver)

setReadWrite

public NetIdData setReadWrite(NetIdData.IMsgDataReceiver receiver, NetIdData.IMsgDataWriter writer)

send

public void send(ActiveConnection connection)

Sends this signal over the specified connection

send

public void send(ActiveConnection connection, NetIdData.IMsgDataWriter writer)

withoutBuffering

public NetIdData withoutBuffering()

Description copied from class: NetIdBase

Changes the flags for this packet to indicate that it should never be buffered by a BufferedConnection. This means that it will arrive on the other end of the connection before other packets that don't have this flag set. Sending a lot of these "queue-skipping packets" will generally have a large impact on performance.

Unlike all of the other flag modification methods this may be called at any time, in particular before and after sending this.

This method should be preferred over NetIdBase.notBuffered() because it returns itself.

Specified by:

withoutBuffering in class NetIdBase

Returns:

This.

withTinySize

public NetIdData withTinySize()

Description copied from class: NetIdBase

Changes the size flags of this net ID to indicate that it should use a single byte for the packet's total length (including the header). In other words the maximum packet length is 256 bytes, and the minimum is 1 byte. Has no effect if the packet's length is not fixed.

This method should be preferred over NetIdBase.setTinySize() because it returns itself.

Specified by:

withTinySize in class NetIdBase

See Also:

NetIdBase.withNormalSize(), NetIdBase.withLargeSize()

withNormalSize

public NetIdData withNormalSize()

Description copied from class: NetIdBase

Changes the size flags of this net ID to indicate that it should use two bytes for the packet's total length (including the header). In other words the maximum packet length is 65,536 bytes, and the minimum is 1 byte. Has no effect if the packet's length is not fixed.

This method should be preferred over NetIdBase.setNormalSize() because it returns itself.

Specified by:

withNormalSize in class NetIdBase

See Also:

NetIdBase.withTinySize(), NetIdBase.withLargeSize()

withLargeSize

public NetIdData withLargeSize()

Description copied from class: NetIdBase

Changes the size flags of this net ID to indicate that it should use three bytes for the packet's total length (including the header). In other words the maximum packet length is 16,777,216 bytes, and the minimum is 1 byte. Has no effect if the packet's length is not fixed.

Unlike all of the other flag modification methods this may be called at any time, in particular before and after sending this.

This method should be preferred over NetIdBase.setLargeSize() because it returns itself.

Specified by:

withLargeSize in class NetIdBase

See Also:

NetIdBase.withTinySize(), NetIdBase.withNormalSize()

toClientOnly

public NetIdData toClientOnly()

Description copied from class: NetIdBase

Changes the flags for this packet to indicate that it should only be sent from the server to the client. This will make sending this packet from the client throw an unchecked exception, and make the server refuse to bind this packet to an integer ID for receiving.

Specified by:

toClientOnly in class NetIdBase

See Also:

NetIdBase.toServerOnly()

toServerOnly

public NetIdData toServerOnly()

Description copied from class: NetIdBase

Changes the flags for this packet to indicate that it should only be sent from the client to the server. This will make sending this packet from the server throw an unchecked exception, and make the client refuse to bind this packet to an integer ID for receiving.

Specified by:

toServerOnly in class NetIdBase

See Also:

NetIdBase.toClientOnly()

toEitherSide

public NetIdData toEitherSide()

Description copied from class: NetIdBase

This clears the NetIdBase.toClientOnly() and NetIdBase.toServerOnly() flag states, and will make sending packets not throw exceptions.

This is the default state for every NetIdBase.

Specified by:

toEitherSide in class NetIdBase