Mesibo Chatbot and Scripting - Introduction

Estimated reading time: 2 minutes

The Socket class can be used to connect to a host through a scoket, to send and receive data asynchronously.

Constructor

Socket(url)

The constructor initializes the Socket class. It must be called before you perform any method calls. Call the constructor by passing the url(For websockets) or host address(for regular sockets).

The URL is to be specified in the format: <type>://<url>

The following types are available:

  • sock: Regular sockets
  • socks: Secure Regular Sockets
  • ws: Web Sockets
  • wss: Secure Web Sockets

Example

//Regular Sockets
var s = new Socket("sock://example.com");

//Secure Regular Sockets
var ss = new Socket("socks://example.com");

//Websockets
var ws = new Socket("ws://echo.websocket.org");

//Secure Websockets
var wss = new Socket("wss://echo.websocket.org");

Properties

To connect to a socket set the following properties for a Socket class object.

keepalive

Enable for persistent connection

verify_host

enableSsl

Configure SSL

Socket.onconnect

An event listener to be called when connected to the server(host)

Socket.ondata compulsory

An event listener to be called when data is received from the server(host)

Socket.onwrite

An event listener to be called when data is written to socket

Socket.onclose

An event listener to be called when the connection is closed.

Methods

Socket.open()

Open a new connection on specified host.

Socket.send()

Send data to connected host

Socket.close()

Close connection

Example

var s = new Socket("sock://example.com:80");
s.onconnect = function(s) {
	print("connected");
	s.send("GET / HTTP/1.0\r\nHost: example.com\r\nConnection: close\r\n\r\n");
}

s.ondata = function(s) {
	print(s);
}

s.open();

Usage notes

Global instantiation restriction

An object of the class Socket cannot be instantiated in global context. Ensure that you are creating the instance inside a scoped area or function.

chatbot, script, scripting