https://github.com/socketio/socket.io-client-cpp

C++11 implementation of Socket.IO client
https://github.com/socketio/socket.io-client-cpp

Last synced: about 1 month ago
JSON representation

C++11 implementation of Socket.IO client

• Host: GitHub
• URL: https://github.com/socketio/socket.io-client-cpp
• Owner: socketio
• License: mit
• Created: 2015-03-29T19:31:21.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-08-16T07:13:22.000Z (3 months ago)
• Last Synced: 2024-09-29T01:02:09.177Z (about 2 months ago)
• Language: C++
• Size: 1020 KB
• Stars: 2,253
• Watchers: 113
• Forks: 727
• Open Issues: 159
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Socket.IO C++ Client

[![Build Status](https://github.com/socketio/socket.io-client-cpp/workflows/CI/badge.svg)](https://github.com/socketio/socket.io-client-cpp/actions)

By virtue of being written in C++, this client works in several different platforms. The [examples](https://github.com/socketio/socket.io-client-cpp/tree/master/examples) folder contains an iPhone, QT and Console example chat client! It depends on [websocket++](https://github.com/zaphoyd/websocketpp) and is inspired by [socket.io-clientpp](https://github.com/ebshimizu/socket.io-clientpp).

[![Clients with iPhone, QT, Console and web](https://cldup.com/ukvVVZmvYV.png)](https://github.com/socketio/socket.io-client-cpp/tree/master/examples)

## Compatibility table

  

    C++ Client version

    Socket.IO server version

  

  

    1.x / 2.x

    3.x / 4.x

  

  

    2.x (2.x branch)

    YES

    YES, with allowEIO3: true

  

  

    3.x (master branch)

    NO

    YES

  

## Features

- 100% written in modern C++11

- Binary support

- Automatic JSON encoding

- Multiplex support

- Similar API to the Socket.IO JS client

- Cross platform

Note: Only the WebSocket transport is currently implemented (no fallback to HTTP long-polling)

## Installation alternatives

* [With CMAKE](./INSTALL.md#with-cmake)

* [Without CMAKE](./INSTALL.md#without-cmake)

* [With VCPKG](./INSTALL.md#with-vcpkg)

* [With Conan](./INSTALL.md#with-conan)

* [iOS and OS X](./INSTALL_IOS.md)

 * Option 1: Cocoapods

 * Option 2: Create a static library

 * Option 3: Manual integration

## Quickstart

** [Full overview of API can be seen here](./API.md) **

The APIs are similar to the JS client.

#### Connect to a server

```C++

sio::client h;

h.connect("http://127.0.0.1:3000");

```

#### Emit an event

```C++

// emit event name only:

h.socket()->emit("login");

// emit text

h.socket()->emit("add user", username);

// emit binary

char buf[100];

h.socket()->emit("add user", std::make_shared(buf,100));

// emit message object with lambda ack handler

h.socket()->emit("add user", string_message::create(username), [&](message::list const& msg) {

});

// emit multiple arguments

message::list li("sports");

li.push(string_message::create("economics"));

socket->emit("categories", li);

```

Items in `message::list` will be expanded in server side event callback function as function arguments.

#### Bind an event

##### Bind with function pointer

```C++

void OnMessage(sio::event &)

{

}

h.socket()->on("new message", &OnMessage);

```

##### Bind with lambda

```C++

h.socket()->on("login", [&](sio::event& ev)

{

    //handle login message

    //post to UI thread if any UI updating.

});

```

##### Bind with member function

```C++

class MessageHandler

{

public:

    void OnMessage(sio::event &);

};

MessageHandler mh;

h.socket()->on("new message",std::bind( &MessageHandler::OnMessage,&mh,std::placeholders::_1));

```

#### Using namespace

```C++

h.socket("/chat")->emit("add user", username);

```

** [Full overview of API can be seen here](./API.md) **

## License

MIT