DeepStreamNet

dotnet Client for deepstream.io

Builds

NuGet

Frameworks

• DotNet >= 4.5
• NetStandard >= 1.5

Usage

//connect to default deepstream instance
var client = new DeepStreamClient("localhost", 6020, "deepstream");

//connect to deepstreamhub.com
var client = new DeepStreamClient("123.deepstreamhub.com", 443, "?apiKey=abc", true);

if(await client.LoginAsync())
{
 //Login was successful   
}

//Alternative with credentials
await client.LoginAsync("Username", "Password");

// Close Connection to deepstream.io endpoint
client.Dispose();

Events

// Subscribe to Event 'test'
var eventSubscription = await client.Events.SubscribeAsync("test", x => { Console.WriteLine(x); });

// Send 'Hello' to all Subscribers of Event 'test'
client.Publish("test", "Hello");

// Send number '42' to all Subscribers of Event 'test'
client.Publish("test", 42);

// Send object '{Property1="Hello", Property2=42}' to all Subscribers of Event 'test'
client.Publish("test", new {Property1="Hello", Property2=42});

// Unsubscribe from Event 'test'
await eventSubscription.DisposeAsync();

// Listen to events
var listener = await client.Events.ListenAsync("^test/.*", (eventName, isSubscribed, response) =>
{
   if (isSubscribed)
   {
      if (/* if you want to provide */)
      {
         response.Accept();
         client.Events.Publish(eventName, "Hello World");
         // start publishing data via client.Events.Publish(eventName, /* data */)
      }
      else
      {
          response.Reject(); // let deepstream ask another provider
      }
    }
    else
    {
        // stop publishing data
    }
});

// Unlisten
await listener.DisposeAsync();

Records

IDeepStreamRecord record = await client.Records.GetRecordAsync("test");

// check if Record exists
bool has = await client.Records.HasAsync("test"); //returns true

record["FirstName"] = "John";
record["Age"] = 28;

//Snapshot of record without changetracking
IDeepStreamRecord fixedRecord = await client.Records.SnapshotAsync("text");

// Discard all changes
await client.Records.DiscardAsync(record);

// Delete Records
await client.Records.DeleteAsync(record);

Dynamic Records

dynamic record = await client.Records.GetRecordAsync("test");

record.FirstName = "Jane";
record.Age = 21;

AnonymousRecord

IDeepStreamAnonymousRecord arecord = client.Records.GetAnonymousRecord();

await arecord.SetNameAsync("atest");

RPC Request

//Request RemoteProcedure 'toUpperCase' with argument 'abc'
var result = await client.Rpcs.MakeRequest<string,string>("toUpperCase", "abc");
//result == "ABC"

RPC Provider

//Define Method for RemoteProcedure
void ToUpperCase(string input, IRpcResponse<string> response)
{
    if (string.IsNullOrEmpty(input))
        response.Error("input must not be empty");

    if (input == "ABC")
        response.Reject();

    response.Send(input.ToUpper());
}

//Register RemoteProcedure 'toUpperCase' with InputArgs as string and Result as string
var proc = await client.Rpcs.RegisterProviderAsync<string, string>("toUpperCase", ToUpperCase);

//alternative with anonymous Method as RemoteProcedure
var proc = await client.Rpcs.RegisterProviderAsync<string, string>("toUpperCase", (input,response)=> response.Send(input.ToUpper()));


//Define async Method for RemoteProcedure
async Task ToUpperCaseAsync(string input, IRpcResponse<string> response)
{
    if (string.IsNullOrEmpty(input))
        response.Error("input must not be empty");

    if (input == "ABC")
        response.Reject();

    await Task.Delay(500);

    response.Send(input.ToUpper());
}

//Register async RemoteProcedure 'toUpperCase' with InputArgs as string and Result as string
var proc = await client.Rpcs.RegisterProviderAsync<string, string>("toUpperCase", ToUpperCaseAsync);

//alternative with anonymous Method as RemoteProcedure
var proc = await client.Rpcs.RegisterProviderAsync<string, string>("toUpperCase", async (input,response)=> {
    await Task.Delay(500);
    response.Send(input.ToUpper();
    }));

//Unregister RemoteProcedure
await proc.DisposeAsync(); 

Presence

var users = await client.Presence.GetAllAsync(); //result IEnumerable<string> -> usernames

var subscription = await client.Presence.SubscribeAsync((username, isLoggedIn)=>{
    if(isLoggedIn){
        Console.WriteLine(username +" is logged in")
    }
    else{
        Console.WriteLine(username +" is logged out")
    }    
});

//Unregister Subscription
await subscription.DisposeAsync();