Home » Docs » Server »
 

sockClient

(since 1.0)



A client socket class

Description


sockClient

Ape.sockClient is a class constructor. SockClient are used to connect to a socket server.

Parameters


port
The port to connect to

host
The host to connect to can be either an ip or an hostname

options
  • flushlf - (bool) ; defaults to : false If true onRead is called only when a "\n" is received (data is split around it)

Examples


//Instantiating a socket client is simple
var socket = new Ape.sockClient('21', 'example.com', {flushlf: true} );

var socket = new Ape.sockClient('21', 'example.com', {flushlf: true});
 
socket.onConnect = function() {
	Ape.log("Connected to example.com");
	this.write("Hello\n");
}
"\n" are removed.
socket.onRead = function(data) {
	Ape.log("Data : " + data);
}
 
socket.onDisconnect = function() {
	Ape.log("Gone !");
}

See also


User notes


# No comment

Post a note


User notes may be edited or deleted, and usually a note is deleted because of the following reasons:
  • Bugs: Instead report a bug
  • Missing documentation: report that as a bug.
  • Support questions: See the community for available options.

In other words, do not ask questions within the user notes.

Note <b>,<u>,<i> HTML tags are allowed in the posts and the note formatting is preserved. URLs will be turned into clickable links, JavaScipt and C code blocks enclosed in the <source="javascript">JS Code</source> and <source="c">C Code</source> tags will be source highlighted automatically.