Skip to content

DanielBaulig/chat.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

chat.io

chat.io is a simple socket.io based chat solution.

Example:

See example/simple-chat/.

Installation

npm install chat.io

Features

Server:

    require('chat.io').createChat(io.sockets);

    var guestCounter = 0;
    io.set('authorization', function (handshake, accept) {
        return accept(null, handshake.nickname = 'Guest'+ ++guestCounter);
    });

Client:

    var socket = io.connect('http://localhost');

    socket.on('say', function (user, message) {
        messages.append(user+'> '+message);
    });

Server:

    require('chat.io').createChat(io.of('/chat'));

    var guestCounter = 0;
    io.of('/chat').authorization(function (handshake, accept) {
        return accept(null, handshake.nickname = 'Guest'+ ++guestCounter);
    });

Client:

    var socket = io.connect('http://localhost/chat');

Client:

    // beeing notified
    socket.on('join', function (user) {
        message.append(user + ' joined your channel.');
    });

    // joining
    socket.emit('join', 'aChannel', function (err) {
        if (err) messages.append('Error joining aChannel: ' + err);
    });

Client:

    // receiving
    socket.on('whisper', function (user, message) {
        messages.append('<i>from '+user+'> '+message+'</i>');
    });
    
    // sending
    socket.emit('whisper', 'aUser', 'Hello, aUser!', function (err) {
        if (err) messages.append('Error whipering aUser: '+err);
    });

Server:

    chat.on('connection', function (nickname) {
        if ('badyGuy' === nickname)  {
            chat.kick(nickname);
        }
    });

Server:

    // deactivate channel switching
    chat.set('channel join permission', false);

    // permission callback
    chat.set('channel join permission', function (user, channel, allow) {
        if ('operator' === user) {
            return allow(true);
        }
        if ('secret' === channel) {
            return allow(false);
        }
        return allow(true);
    });

Client:

    socket.on('message', function (message) {
        messages.append(message);
    });

Server:

    // global messages
    chat.sendSystem('Server shutting down in 10 minutes.');

    // channel messages
    chat.sendChannel(aChannel, 'This channel is supervised. Please behave.');

    // user messages
    chat.sendUser(aUser, 'This is your first visit, please read the guidelines.');

Documentation

For now, please see the example and the source code for additional documentation.

Tests

make test

License

Copyright (c) 2012 Daniel Baulig [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

A simple chat solution build on socket.io

Resources

License

Stars

Watchers

Forks

Packages

No packages published