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

The net IFactory interface.


Table members

Methods


Init()

Initialize the factory.

Boolean Init()

Returns
Boolean true if successful.

DeInit()

Deinitialize the factory.

Boolean DeInit()

Returns
Boolean true if successful.

CreateSocket()

Create a socket SharedPointer object.

Murl.SharedPointer.NetISocket CreateSocket()

Returns
Murl.SharedPointer.NetISocket The created socket SharedPointer object.

CreateRawSocket()

Create a socket object.

Murl.Net.ISocket CreateRawSocket()

Returns
Murl.Net.ISocket The created socket object, or null if failed.

DestroyRawSocket(socket)

Destroy a socket object.

Boolean, Murl.Net.ISocket DestroyRawSocket(Murl.Net.ISocket socket)

Parameters
socketA reference to the socket object pointer. After destruction the pointer is set to null.
Returns
Boolean true if successful.
Murl.Net.ISocket socket A reference to the socket object pointer. After destruction the pointer is set to null.

CreateSocketAddress()

Create a socket address SharedPointer object.

Murl.SharedPointer.NetISocketAddress CreateSocketAddress()

Returns
Murl.SharedPointer.NetISocketAddress The created socket address SharedPointer object.

CreateRawSocketAddress()

Create a socket address object.

Murl.Net.ISocketAddress CreateRawSocketAddress()

Returns
Murl.Net.ISocketAddress The created socket address object, or null if failed.

DestroyRawSocketAddress(socketAddress)

Destroy a socket address object. Alternatively the ISocketAddress object can be destroyed by using delete.

Boolean, Murl.Net.ISocketAddress DestroyRawSocketAddress(Murl.Net.ISocketAddress socketAddress)

Parameters
socketAddressA reference to the socket address object pointer. After destruction the pointer is set to null.
Returns
Boolean true if successful.
Murl.Net.ISocketAddress socketAddress A reference to the socket address object pointer. After destruction the pointer is set to null.

CreateSocketClient(clientName, uniqueId)

Create a socket client object.

Murl.Net.ISocketClient CreateSocketClient(String clientName, String uniqueId)

Parameters
clientNameThe name of the client.
uniqueIdThe unique identifer of the client.
Returns
Murl.Net.ISocketClient The created socket client object, or null if failed.

DestroySocketClient(socketClient)

Destroy a socket client object.

Boolean, Murl.Net.ISocketClient DestroySocketClient(Murl.Net.ISocketClient socketClient)

Parameters
socketClientA reference to the socket client object pointer. After destruction the pointer is set to null.
Returns
Boolean true if successful.
Murl.Net.ISocketClient socketClient A reference to the socket client object pointer. After destruction the pointer is set to null.

CreateSocketPacket()

Create a socket packet object.

Murl.Net.ISocketPacket CreateSocketPacket()

Returns
Murl.Net.ISocketPacket The created socket packet object, or null if failed.

DestroySocketPacket(socketPacket)

Destroy a socket packet object. Alternatively the ISocketPacket object can be destroyed by using delete.

Boolean, Murl.Net.ISocketPacket DestroySocketPacket(Murl.Net.ISocketPacket socketPacket)

Parameters
socketPacketA reference to the socket packet object pointer. After destruction the pointer is set to null.
Returns
Boolean true if successful.
Murl.Net.ISocketPacket socketPacket A reference to the socket packet object pointer. After destruction the pointer is set to null.

CreateSocketServer(serverName, uniqueId)

Create a socket server object.

Murl.Net.ISocketServer CreateSocketServer(String serverName, String uniqueId)

Parameters
serverNameThe name of the server.
uniqueIdThe unique identifer of the server.
Returns
Murl.Net.ISocketServer The created socket server object, or null if failed.

DestroySocketServer(socketServer)

Destroy a socket server object.

Boolean, Murl.Net.ISocketServer DestroySocketServer(Murl.Net.ISocketServer socketServer)

Parameters
socketServerA reference to the socket server object pointer. After destruction the pointer is set to null.
Returns
Boolean true if successful.
Murl.Net.ISocketServer socketServer A reference to the socket server object pointer. After destruction the pointer is set to null.