1. module raw-socket
   1. function raw-socket.Socket (options)
   2. function raw-socket.createChecksum ()
   3. function raw-socket.createSocket (options)
   4. function raw-socket.htonl ()
   5. function raw-socket.htons ()
   6. function raw-socket.ntohl ()
   7. function raw-socket.ntohs ()
   8. function raw-socket.writeChecksum (buffer, offset, checksum)
   9. object raw-socket.AddressFamily
   10. object raw-socket.Protocol
   11. object raw-socket.Socket.prototype
   12. object raw-socket.SocketLevel
   13. object raw-socket.SocketOption
2. module raw-socket.Socket
   1. function raw-socket.Socket (options)
   2. function raw-socket.Socket.super_ ()
3. module raw-socket.Socket.prototype
   1. function raw-socket.Socket.prototype.close ()
   2. function raw-socket.Socket.prototype.getOption (level, option, value, length)
   3. function raw-socket.Socket.prototype.onClose ()
   4. function raw-socket.Socket.prototype.onError (error)
   5. function raw-socket.Socket.prototype.onRecvReady ()
   6. function raw-socket.Socket.prototype.onSendReady ()
   7. function raw-socket.Socket.prototype.pauseRecv ()
   8. function raw-socket.Socket.prototype.pauseSend ()
   9. function raw-socket.Socket.prototype.resumeRecv ()
   10. function raw-socket.Socket.prototype.resumeSend ()
   11. function raw-socket.Socket.prototype.send (buffer, offset, length, address, beforeCallback, afterCallback)
   12. function raw-socket.Socket.prototype.setOption (level, option, value, length)

module raw-socket

function raw-socket.Socket (options)

• description and source-code

  function Socket(options) {
  	Socket.super_.call (this);
  
  	this.requests = [];
  	this.buffer = new Buffer ((options && options.bufferSize)
  			? options.bufferSize
  			: 4096);
  
  	this.recvPaused = false;
  	this.sendPaused = true;
  
  	this.wrap = new raw.SocketWrap (
  			((options && options.protocol)
  					? options.protocol
  					: 0),
  			((options && options.addressFamily)
  					? options.addressFamily
  					: AddressFamily.IPv4)
  		);
  
  	var me = this;
  	this.wrap.on ("sendReady", this.onSendReady.bind (me));
  	this.wrap.on ("recvReady", this.onRecvReady.bind (me));
  	this.wrap.on ("error", this.onError.bind (me));
  	this.wrap.on ("close", this.onClose.bind (me));
  }

• example usage

  n/a

function raw-socket.createChecksum ()

• description and source-code

  createChecksum = function () {
  	var sum = 0;
  	for (var i = 0; i < arguments.length; i++) {
  		var object = arguments[i];
  		if (object instanceof Buffer) {
  			sum = raw.createChecksum (sum, object, 0, object.length);
  		} else {
  			sum = raw.createChecksum (sum, object.buffer, object.offset,
  					object.length);
  		}
  	}
  	return sum;
  }

• example usage

  ...
  Both buffers will be treated as one, i.e. as if the data at offset `20` in
  `tcp_packet` had followed all data in `pseudo_header` - as if they were one
  buffer.
  
  ## raw.writeChecksum (buffer, offset, checksum)
  
  The `writeChecksum()` function writes a checksum created by the
  `raw.createChecksum()` function to the [Node.js][nodejs] `Buffer` object
  `buffer` at offsets `offset` and `offset` + 1.
  
  The following example generates and writes a checksum at offset `2` in a
  [Node.js][nodejs] `Buffer` object:
  
  raw.writeChecksum (buffer, 2, raw.createChecksum (buffer));
  ...

function raw-socket.createSocket (options)

• description and source-code

  createSocket = function (options) {
  	return new Socket (options || {});
  }

• example usage

  n/a

function raw-socket.htonl ()

• description and source-code

  htonl = function () { [native code] }

• example usage

  n/a

function raw-socket.htons ()

• description and source-code

  htons = function () { [native code] }

• example usage

  n/a

function raw-socket.ntohl ()

• description and source-code

  ntohl = function () { [native code] }

• example usage

  n/a

function raw-socket.ntohs ()

• description and source-code

  ntohs = function () { [native code] }

• example usage

  n/a

function raw-socket.writeChecksum (buffer, offset, checksum)

• description and source-code

  writeChecksum = function (buffer, offset, checksum) {
  	buffer.writeUInt8 ((checksum & 0xff00) >> 8, offset);
  	buffer.writeUInt8 (checksum & 0xff, offset + 1);
  	return buffer;
  }

• example usage

  n/a

module raw-socket.Socket

function raw-socket.Socket (options)

• description and source-code

  function Socket(options) {
  	Socket.super_.call (this);
  
  	this.requests = [];
  	this.buffer = new Buffer ((options && options.bufferSize)
  			? options.bufferSize
  			: 4096);
  
  	this.recvPaused = false;
  	this.sendPaused = true;
  
  	this.wrap = new raw.SocketWrap (
  			((options && options.protocol)
  					? options.protocol
  					: 0),
  			((options && options.addressFamily)
  					? options.addressFamily
  					: AddressFamily.IPv4)
  		);
  
  	var me = this;
  	this.wrap.on ("sendReady", this.onSendReady.bind (me));
  	this.wrap.on ("recvReady", this.onRecvReady.bind (me));
  	this.wrap.on ("error", this.onError.bind (me));
  	this.wrap.on ("close", this.onClose.bind (me));
  }

• example usage

  n/a

function raw-socket.Socket.super_ ()

• description and source-code

  function EventEmitter() {
    EventEmitter.init.call(this);
  }

• example usage

  n/a

module raw-socket.Socket.prototype

function raw-socket.Socket.prototype.close ()

• description and source-code

  close = function () {
  	this.wrap.close ();
  	return this;
  }

• example usage

  n/a

function raw-socket.Socket.prototype.getOption (level, option, value, length)

• description and source-code

  getOption = function (level, option, value, length) {
  	return this.wrap.getOption (level, option, value, length);
  }

• example usage

  n/a

function raw-socket.Socket.prototype.onClose ()

• description and source-code

  onClose = function () {
  	this.emit ("close");
  }

• example usage

  n/a

function raw-socket.Socket.prototype.onError (error)

• description and source-code

  onError = function (error) {
  	this.emit ("error", error);
  	this.close ();
  }

• example usage

  n/a

function raw-socket.Socket.prototype.onRecvReady ()

• description and source-code

  onRecvReady = function () {
  	var me = this;
  	try {
  		this.wrap.recv (this.buffer, function (buffer, bytes, source) {
  			var newBuffer = buffer.slice (0, bytes);
  			me.emit ("message", newBuffer, source);
  		});
  	} catch (error) {
  		me.emit ("error", error);
  	}
  }

• example usage

  n/a

function raw-socket.Socket.prototype.onSendReady ()

• description and source-code

  onSendReady = function () {
  	if (this.requests.length > 0) {
  		var me = this;
  		var req = this.requests.shift ();
  		try {
  			if (req.beforeCallback)
  				req.beforeCallback ();
  			this.wrap.send (req.buffer, req.offset, req.length,
  					req.address, function (bytes) {
  				req.afterCallback.call (me, null, bytes);
  			});
  		} catch (error) {
  			req.afterCallback.call (me, error, 0);
  		}
  	} else {
  		if (! this.sendPaused)
  			this.pauseSend ();
  	}
  }

• example usage

  ...
  
   * Default protocol option to `createSession()` was incorrect in the README.md
   * The `session.on("message")` example used `message` instead of `buffer` in
     the README.md
  
  ## Version 1.1.3 - 04/03/2013
  
   * `raw.Socket.onSendReady()` emit's an error when `raw.SocketWrap.send()`
     throws an exception when it should call the `req.callback` callback
   * Added the `pauseRecv()`, `resumeRecv()`, `pauseSend()` and `resumeSend()`
     methods
  
  [net-ping]: https://npmjs.org/package/net-ping "net-ping"
  
  ## Version 1.1.4 - 05/03/2013
  ...

function raw-socket.Socket.prototype.pauseRecv ()

• description and source-code

  pauseRecv = function () {
  	this.recvPaused = true;
  	this.wrap.pause (this.recvPaused, this.sendPaused);
  	return this;
  }

• example usage

  n/a

function raw-socket.Socket.prototype.pauseSend ()

• description and source-code

  pauseSend = function () {
  	this.sendPaused = true;
  	this.wrap.pause (this.recvPaused, this.sendPaused);
  	return this;
  }

• example usage

  n/a

function raw-socket.Socket.prototype.resumeRecv ()

• description and source-code

  resumeRecv = function () {
  	this.recvPaused = false;
  	this.wrap.pause (this.recvPaused, this.sendPaused);
  	return this;
  }

• example usage

  n/a

function raw-socket.Socket.prototype.resumeSend ()

• description and source-code

  resumeSend = function () {
  	this.sendPaused = false;
  	this.wrap.pause (this.recvPaused, this.sendPaused);
  	return this;
  }

• example usage

  n/a

function raw-socket.Socket.prototype.send (buffer, offset, length, address, beforeCallback, afterCallback)

• description and source-code

  send = function (buffer, offset, length, address, beforeCallback, afterCallback) {
  	if (! afterCallback) {
  		afterCallback = beforeCallback;
  		beforeCallback = null;
  	}
  
  	if (length + offset > buffer.length)  {
  		afterCallback.call (this, new Error ("Buffer length '" + buffer.length
  				+ "' is not large enough for the specified offset '" + offset
  				+ "' plus length '" + length + "'"));
  		return this;
  	}
  
  	if (! net.isIP (address)) {
  		afterCallback.call (this, new Error ("Invalid IP address '" + address + "'"));
  		return this;
  	}
  
  	var req = {
  		buffer: buffer,
  		offset: offset,
  		length: length,
  		address: address,
  		afterCallback: afterCallback,
  		beforeCallback: beforeCallback
  	};
  	this.requests.push (req);
  
  	if (this.sendPaused)
  		this.resumeSend ();
  
  	return this;
  }

• example usage

  ...
  
   * Default protocol option to `createSession()` was incorrect in the README.md
   * The `session.on("message")` example used `message` instead of `buffer` in
     the README.md
  
  ## Version 1.1.3 - 04/03/2013
  
   * `raw.Socket.onSendReady()` emit's an error when `raw.SocketWrap.send()`
     throws an exception when it should call the `req.callback` callback
   * Added the `pauseRecv()`, `resumeRecv()`, `pauseSend()` and `resumeSend()`
     methods
  
  [net-ping]: https://npmjs.org/package/net-ping "net-ping"
  
  ## Version 1.1.4 - 05/03/2013
  ...

function raw-socket.Socket.prototype.setOption (level, option, value, length)

• description and source-code

  setOption = function (level, option, value, length) {
  	if (arguments.length > 3)
  		this.wrap.setOption (level, option, value, length);
  	else
  		this.wrap.setOption (level, option, value);
  }

• example usage

  n/a