Protocols Javascript

Default Javascript sgcWebSockets uses sgcWebSocket.js file.

Here you can find available methods, you need to replace {%host%} and {%port%} variables as needed, example: if you have configured your sgcWebSocket server to listen port 80 on www.example.com website you need to configure your access to sgcWebSocket.js file as:


<script src="http://www.example.com:80/sgcWebSockets.js"></script>

Open Connection

<script src="http://{%host%}:{%port%}/sgcWebSockets.js"></script>
<script>
  var socket = new sgcWebSocket('ws://{%host%}:{%port%}');
</script>

sgcWebSocket has 3 parameters, only first is required:

sgcWebSocket(url, protocol, transport)

URL: WebSocket server location, you can use "ws:" for normal WebSocket connections and "wss:" for secured WebSocket connections.

sgcWebSocket('ws://127.0.0.1')

sgcWebSocket('wss://127.0.0.1')

Protocol: if the server accepts one or more protocol, you can define which is the protocol you want to use.

sgcWebSocket('ws://127.0.0.1', 'esegece.com')

Transport: by default, first tries to connect using WebSocket connection and if not implemented by Browser, then tries Server Sent Events as Transport.

Use WebSocket if implemented, if not, then use Server Sent Events:

sgcWebSocket('ws://127.0.0.1')

Only use WebSocket as transport:

sgcWebSocket('ws://127.0.0.1', '', ['websocket'])

Only use Server Sent as transport:

sgcWebSocket('ws://127.0.0.1', '', ['sse'])

Open Connection With Authentication


<script src="http://{%host%}:{%port%}/sgcWebSockets.js"></script>
<script>
  var socket = new sgcWebSocket({"host":"ws://{%host%}:{%port%}","user":"admin","password":"1234"});
</script>

Send Message


<script src="http://{%host%}:{%port%}/sgcWebSockets.js"></script>
<script>
  var socket = new sgcWebSocket('ws://{%host%}:{%port%}');
  socket.send('Hello sgcWebSockets!');
</script>

Show Alert with Message Received


<script src="http://{%host%}:{%port%}/sgcWebSockets.js"></script>
<script>
  var socket = new sgcWebSocket('ws://{%host%}:{%port%}');
  socket.on('message', function(event)
  {  
    alert(event.message);
  }
</script>

Binary Message Received


<script src="http://{%host%}:{%port%}/sgcWebSockets.js"></script>
<script>
  var socket = new sgcWebSocket('ws://{%host%}:{%port%}');
  socket.on('stream', function(event)
  {  
    document.getElementById('image').src = URL.createObjectURL(event.stream);
    event.stream = "";
  }
</script>

Binary (Header + Image) Message Received


<script src="http://{%host%}:{%port%}/sgcWebSockets.js"></script>
<script>
  var socket = new sgcWebSocket('ws://{%host%}:{%port%}');
  socket.on('stream', function(event)
  {  
    sgcWSStreamRead(evt.stream, function(header, stream) {
      document.getElementById('text').innerHTML = header;
      document.getElementById('image').src = URL.createObjectURL(event.stream);
      event.stream = "";
    }
  }
</script>

Show Alert OnConnect, OnDisconnect and OnError Events


<script src="http://{%host%}:{%port%}/sgcWebSockets.js"></script>
<script>
  var socket = new sgcWebSocket('ws://{%host%}:{%port%}');
  socket.on('open', function(event)
  {  
    alert('sgcWebSocket Open!');
  };
  socket.on('close', function(event)
  {  
    alert('sgcWebSocket Closed!');
  };
  socket.on('error', function(event)
  {  
    alert('sgcWebSocket Error: ' + event.message);
  };
</script>

Close Connection


<script src="http://{%host%}:{%port%}/sgcWebSockets.js"></script>
<script>
  socket.close();
</script>

Get Connection Status


<script src="http://{%host%}:{%port%}/sgcWebSockets.js"></script>
<script>
  socket.state();
</script>