Code Monkey home page Code Monkey logo

socket.io-client's Introduction

This Readme corresponds to the upcoming 1.0 release. Please refer to http://socket.io for the current 0.9.x documentation.

socket.io-client

Build Status

How to use

Standalone

A standalone build of socket.io-client is exposed automatically by the socket.io server as /socket.io/socket.io.js. Alternatively you can serve the file socket.io-client.js found at the root of this repository.

<script src="/socket.io/socket.io.js"></script>
<script>
  var socket = io('http://localhost');
  socket.on('connect', function(){
    socket.on('event', function(data){});
    socket.on('disconnect', function(){});
  });
</script>

Component

Socket.IO is a component, which means you can include it by using require on the browser:

var socket = require('socket.io')('http://localhost');
socket.on('connect', function(){
  socket.on('event', function(data){});
  socket.on('disconnect', fucntion(){});
});

Node.JS

Add socket.io-client to your package.json and then:

var socket = require('socket.io-client')('http://localhost');
socket.on('connect', function(){
  socket.on('event', function(data){});
  socket.on('disconnect', fucntion(){});
});

API

IO(url:String, opts:Object):Socket

Exposed as the io namespace in the standalone build, or the result of calling require('socket.io-client').

When called, it creates a new Manager for the given URL, and attempts to reuse an existing Manager for subsequent calls, unless the multiplex option is passed with false.

The rest of the options are passed to the Manager constructor (see below for details).

A Socket instance is returned for the namespace specified by the pathname in the URL, defaulting to /. For example, if the url is http://localhost/users, a transport connection will be established to http://localhost and a Socket.IO connection will be established to /users.

IO#protocol

Socket.io protocol revision number this client works with.

IO#Socket

Reference to the Socket constructor.

IO#Manager

Reference to the Manager constructor.

IO#Emitter

Reference to the Emitter constructor.

Manager(url:String, opts:Object)

A Manager represents a connection to a given Socket.IO server. One or more Socket instances are associated with the manager. The manager can be accessed through the io property of each Socket instance.

The opts are also passed to engine.io upon initialization of the underlying Socket.

  • connect. Fired upon a succesful connection.
  • connect_error. Fired upon a connection error. Parameters:
    • Object error object
  • connect_timeout. Fired upon a connection timeout.
  • reconnect. Fired upon a successful reconnection. Parameters:
    • Number reconnection attempt number
  • reconnect_error. Fired upon a reconnection attempt error. Parameters:
    • Object error object
  • reconnect_failed

Socket

Events

  • connect. Fired upon connecting.
  • error. Fired upon a connection error Parameters:
    • Object error data
  • disconnect. Fired upon a disconnection.

License

MIT

socket.io-client's People

Contributors

rauchg avatar 3rd-eden avatar dvv avatar felixge avatar ycarmel avatar einaros avatar danielbeardsley avatar crickeys avatar sfilatov avatar jdahlq avatar fat avatar gabehollombe avatar zzzaaa avatar amnjdm avatar vedratna-velani avatar vedratna avatar quinndiggity avatar neino3 avatar nateps avatar jscharlach avatar yhpark avatar slnpacifist avatar uoksana avatar stevesanderson avatar pgherveou avatar mixu avatar jugglinmike avatar kreichgauer avatar getify avatar joaojeronimo avatar

Watchers

Chetan Shenoy avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.