Socket.IOの使い方

WebRTCの開発でも使うNode.jsのライブラリSocket.IO。その使い方をまとめてみました。

インストール

Node.js+Expressで動かす場合になります。

$ npm install socket.io
$ npm install express

サーバ <-> クライアント間の通信

サーバ側のサンプルソース

const path = require('path');
const http = require('http');
const express = require('express');
const app = express();

const port = 8000;
const server = http.createServer(app).listen(port, () => {
  console.log('server start. port=' + port);
});
const io = require('socket.io')(server);

io.on('connection', sockect => {
  console.log('socket.id:' + socket.id);

  // 切断時に発生します.
  socket.on('disconnect', reason => {
    console.log(`disconnect: %s, %s`, reason, socket.id);
  });

});

// expressで静的ページにアクセスする.
app.use(express.static(path.join(__dirname, 'static')));
変数ioの定義(代入)方法は一例で、他の指定もあります。

クライアントとの通信は上記のコールバック関数内に記載します。socketは接続された各クライアントになります。

サーバがクライアントからのイベントを受信する

クライアントからのイベントはsocket.on(eventName, callback)で受信します。

socket.on('イベント', data => {
  //
});

部屋に入室する

socket.join('部屋名');

部屋から退室する

socket.leave('部屋名');

サーバからクライアントへイベントを送信する

クライアントへのイベント送信は以下のような方法で行います。

クライアント自身向け

socket.emit('イベント', 'パラメータ');

自分以外の全クライアントにイベントを送信する

socket.broadcast.emit('イベント', 'パラメータ');

自分を含む全クライアントにイベントを送信する

io.emit('イベント', 'パラメータ');

特定のクライアントにイベントを送信する

送信先のソケットIDは相手側のsocket.idで取得できます。

io.to(送信先のソケットID).emit('イベント', 'パラメータ');

特定の部屋のメンバーにイベントを送信する

自分にも送られます。

io.to('部屋名').emit('イベント', 'パラメータ');

クライアントのサンプルソース

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Socket.io Client</title>
    <script src="/socket.io/socket.io.js"></script>
    <script>
        let socket = io('http://localhost:8000');
        // サーバに接続できた場合.
        socket.on('connect', () => {
            console.log('connect success');
        });

        // サーバから'server-send'を受信.
        socket.on('server-send', data => {
            let message = data.message;
            document.getElementById('receive-message').value = message;
        });

        function sendMessage() {
            let message = document.getElementById('send-message').value;
            socket.emit('client-send', {message: message});
        }
    </script>
</head>
<body>
    <p>
        <input type="text" name="sendmessage" value="" id="send-message" style="width: 200px;">
    </p>
    <p>
        <button type="submit" id="send-message-button" onclick="sendMessage();">送信</button>
    </p>
    <p>
        <input type="text" name="receivemessage" value="" id="receive-message" style="width: 200px;">
    </p>
</body>
</html>

サーバに接続する

// サーバに接続.
let socket = io('http://localhost:8000');

socket.on('connect', () => {
  // サーバに接続できた場合.
  console.log('connect success');
});

クライアントでサーバからのイベントを受信する

サーバからのイベントはsocket.on(eventName, callback)で受信します。

socket.on('イベント', data => {
  //
});

クライアントからサーバへイベントを送信する

サーバへのイベント送信はsocket.emit(eventName[, args])を使用します。

socket.emit('イベント', 'パラメータ');
このエントリーをはてなブックマークに追加
にほんブログ村 IT技術ブログへ

関連コンテンツ

スポンサードリンク

Comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です