W3cubDocs

/Haxe Neko

ThreadServer<Client, Message>

package neko.net

extended by ThreadRemotingServer

Available on macro, neko

The ThreadServer can be used to easily create a multithreaded server where each thread polls multiple connections. To use it, at a minimum you must override or rebind clientConnected, readClientMessage, and clientMessage and you must define your Client and Message.

Constructor

new ()

Creates a ThreadServer.

Variables

connectLag:Float

Polling timeout.

errorOutput:Output

Stream to send error messages.

initialBufferSize:Int

Space allocated to buffers when they are created.

listen:Int

Number of total connections the server will accept.

maxBufferSize:Int

Maximum size of buffered data read from a socket. An exception is thrown if the buffer exceeds this value.

maxSockPerThread:Int

The most sockets a thread will handle.

messageHeaderSize:Int

Minimum message size.

nthreads:Int

Number of server threads.

updateTime:Float

Time between calls to update.

Methods

addSocket (s:Socket):Void

Called when the server gets a new connection.

dynamic afterEvent ():Void

Called after a client connects, disconnects, a message is received, or an update is performed.

dynamic clientConnected (s:Socket):Client

Called when a client connects. Returns a client object.

dynamic clientDisconnected (c:Client ):Void

Called when a client disconnects or an error forces the connection to close.

dynamic clientMessage (c:Client, msg:Message ):Void

Called when a message has been received. Message handling code should go here.

dynamic onError (e:Dynamic, stack:Array<StackItem>):Void

Called when an error has occurred.

dynamic readClientMessage (c:Client, buf:Bytes, pos:Int, len:Int):{msg:Message, bytes:Int}

Called when data has been read from a socket. This method should try to extract a message from the buffer. The available data resides in buf, starts at pos, and is len bytes wide. Return the new message and the number of bytes read from the buffer. If no message could be read, return null.

run (host:String, port:Int):Void

Start the server at the specified host and port.

sendData (s:Socket, data:String):Void

Sends data to a client.

stopClient (s:Socket):Void

Shutdown a client's connection and remove them from the server.

dynamic update ():Void

This method is called periodically. It can be used to do server maintenance.

work (f:Void ‑> Void):Void

Internally used to delegate something to the worker thread.

© 2005–2016 Haxe Foundation
Licensed under a MIT license.
http://api.haxe.org/neko/net/ThreadServer.html