class haxe.remoting.SocketProtocol

Available on all platforms

The Haxe Remoting Socket Protocol is composed of serialized string exchanges.

Each string is prefixed with a 2-chars header encoding the string size (up to 4KB)
and postfixed with the \0 message delimiting char.
A request string is composed of the following serialized values :
  • the boolean true for a request
  • an array of strings representing the object+method path
  • an array of parameters A response string is composed of the following serialized values :

  • the boolean false for a response
  • a serialized value representing the result Exceptions are serialized with [serializeException] so they will be thrown immediatly when they are unserialized.

Instance Fields

function new(sock:Socket, ctx:Context):Void

function decodeData(data:String):String

function encodeMessageLength(len:Int):{c2:Null<Int>, c1:Null<Int>}

function isRequest(data:String):Bool

function messageLength(c1:Int, c2:Int):Null<Int>

function processRequest(data:String, ?onError:Array<String> ->Array<Dynamic> ->Dynamic ->Void):Void

function readMessage():String

Available on cpp, java, neko, php

function sendAnswer(answer:Dynamic, ?isException:Bool):Void

function sendMessage(msg:String):Void

function sendRequest(path:Array<String>, params:Array<Dynamic>):Void