Murl Engine Lua Addon API  Version 1.0 beta
Murl.Net.ISocketPacket

The socket packet interface.

Packets are used to transfer network data from and to the Net::SocketClient and Net::SocketServer interfaces.


Table members

Methods


GetSenderName()

Get the sender name.

String GetSenderName()

Returns
String The sender name.

GetUniqueIdentifier()

Get the sender unique identifier.

String GetUniqueIdentifier()

Returns
String The sender unique identifier.

GetAddress()

Get the sender address object.

Murl.SharedPointer.NetISocketAddressConst GetAddress()

Returns
Murl.SharedPointer.NetISocketAddressConst The sender address object.

GetData()

Get the sender data object.

Murl.Data GetData()

Returns
Murl.Data The sender data object.

SetSenderName(senderName)

Set the sender name.

SetSenderName(String senderName)

Parameters
senderNameThe sender name.

SetUniqueIdentifier(uniqueId)

Set the sender unique identifier.

SetUniqueIdentifier(String uniqueId)

Parameters
uniqueIdThe sender unique identifier.

SetAddress(address)

Set the sender address.

SetAddress(Murl.SharedPointer.NetISocketAddressConst address)

Parameters
addressThe sender address.

SetData(data)

Set the sender data object.

SetData(Murl.ConstData data)

Parameters
dataThe sender data to copy.

ObtainData(data)

Obtain the sender data object.

Murl.Data ObtainData(Murl.Data data)

Parameters
dataThe sender data object to obtain.
Returns
Murl.Data data The sender data object to obtain.

GetBytesToSend()

Get the number of bytes to send.

Integer GetBytesToSend()

Returns
Integer The number of bytes to send.

GetBytesSent()

Get the number of sent bytes.

Integer GetBytesSent()

Returns
Integer The number of bytes to send.

GetBytesToReceive()

Get the number of bytes to receive.

Integer GetBytesToReceive()

Returns
Integer The number of bytes to receive.

GetBytesReceived()

Get the number of received bytes.

Integer GetBytesReceived()

Returns
Integer The number of received bytes.

SetBytesToSend(numberOfBytes)

Set the number of bytes to send.

SetBytesToSend(Integer numberOfBytes)

Parameters
numberOfBytesThe number of bytes to send.

SetBytesSent(numberOfBytes)

Set the number of sent bytes.

SetBytesSent(Integer numberOfBytes)

Parameters
numberOfBytesThe number of bytes to send.

SetBytesToReceive(numberOfBytes)

Set the number of bytes to receive.

SetBytesToReceive(Integer numberOfBytes)

Parameters
numberOfBytesThe number of bytes to receive.

SetBytesReceived(numberOfBytes)

Set the number of received bytes.

SetBytesReceived(Integer numberOfBytes)

Parameters
numberOfBytesThe number of received bytes.


Metamethods


The tostring operator

Converts the object content to a string in a reasonable format.

Returns
GetSenderName()