Skip to content

README.md

Latest commit

 

History

History
85 lines (62 loc) · 2.31 KB

README.md

File metadata and controls

85 lines (62 loc) · 2.31 KB

Java WebSockets Client For Android

PieSocket's Android SDK for WebSockets written in Java.

This SDK can be used to communicate with any third-party WebSocket server, and implements auto-reconnection among other best WebSocket practices.

Installation

Let's start by adding PieSocket Android SDK as a dependency to your application.

Gradle (Kotlin)

implementation("com.piesocket:channels-sdk:1.0.5")

Gradle (Java)

implementation 'com.piesocket:channels-sdk:1.0.5'

Maven

<dependency>
    <groupId>com.piesocket</groupId>
    <artifactId>channels-sdk</artifactId>
    <version>1.0.5</version>
</dependency>

Permissions

Setup manifest permissions as instructed here.

Usage

Stand-alone Usage

Create a Channel instance as shown below.

Channel channel = new Channel("wss://example.com", true);

channel.listen("system:connected", new PieSocketEventListener() {
  @Override
  public void handleEvent(PieSocketEvent event) {

    //WebSocket Connected
    channel.send("Hello");

  }
});

Use PieSocket's managed WebSocket server

Use following code to create a Channel with PieSocket's managed WebSocket servers.

Get your API key and Cluster ID here: Get API Key

PieSocketOptions options = new PieSocketOptions();
options.setClusterId("demo");
options.setApiKey("VCXCEuvhGcBDP7XhiJJUDvR1e1D3eiVjgZ9VRiaV");

PieSocket piesocket = new PieSocket(options);
Channel channel = piesocket.join("chat-room-1");

PieSocket Channels is a scalable WebSocket API service with following features:

  • Authentication
  • Private Channels
  • Presence Channels
  • Publish messages with REST API
  • Auto-scalability
  • Webhooks
  • Analytics
  • Authentication
  • Upto 60% cost savings

We highly recommend using PieSocket Channels over self hosted WebSocket servers for production applications.

Events

system:connected is the event fired when WebSocket connection is ready, get a full list system messages here: PieSocket System Messages

Documentation

For usage examples and more information, refer to: Official SDK docs