Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emitter-io/csharp
Client library for emitter.io compatible with .Net, .Net MicroFramework and WinRT
https://github.com/emitter-io/csharp
emitter mqtt-client sdk
Last synced: 12 days ago
JSON representation
Client library for emitter.io compatible with .Net, .Net MicroFramework and WinRT
- Host: GitHub
- URL: https://github.com/emitter-io/csharp
- Owner: emitter-io
- License: epl-1.0
- Created: 2016-01-04T20:12:51.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-05-09T23:19:20.000Z (over 1 year ago)
- Last Synced: 2024-10-04T11:04:19.356Z (about 2 months ago)
- Topics: emitter, mqtt-client, sdk
- Language: C#
- Homepage: http://emitter.io
- Size: 1.84 MB
- Stars: 29
- Watchers: 8
- Forks: 21
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Emitter C# SDK
This repository contains C# client for .Net Framework, .Net Micro Framework and WinRT for [Emitter](https://emitter.io) (see also on [Emitter GitHub](https://github.com/emitter-io/emitter)). Emitter is an **open-source** real-time communication service for connecting online devices. At its core, emitter.io is a distributed, scalable and fault-tolerant publish-subscribe messaging platform based on MQTT protocol and featuring message storage.
 
The current version supports several .Net Frameworks:
* .Net Framework (2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1)
* .Net Micro Framework 4.2, 4.3 and 4.4
* Mono (for Linux O.S.)
The current version also supports WinRT platforms:
* Windows 8.1
* Windows Phone 8.1
* Windows 10
This library provides a nicer MQTT interface fine-tuned and extended with specific features provided by [emitter.io](http://emitter.io). The library is based upon the [M2MQTT library](http://www.m2mqtt.net
) written by [Paolo Patierno](https://m2mqtt.wordpress.com/who/) and released under Eclipse Public License.
# Build Notes
The solution contains C# projects for Micro Framework.
* To build for .Net Micro Framework 4.2 or 4.3, you need to download .Net Micro Framework SDK from CodePlex: https://netmf.codeplex.com/
* To build for .Net Micro Framework 4.4, you need to download .Net Micro Framework SDK from GitHub: https://github.com/NETMF/netmf-interpreter/releases
Alternatively, the files can be downloaded from here:
* [.Net MicroFramework 4.2 & 4.3](https://s3.amazonaws.com/cdn.misakai.com/www-lib/MicroFramework4.3.msi)
* [.Net MicroFramework 4.4](https://s3.amazonaws.com/cdn.misakai.com/www-lib/MicroFramework4.4.msi)
# Nuget
To install Emitter, run the following command in the [Package Manager Console](http://docs.nuget.org/consume/package-manager-console):
```
Install-Package Emitter
```
# Usage
Below is a sample program written using this C# client library. This demonstrates a simple console chat app where the messages are published to `chat` channel and every connected client receives them in real-time.
```
// Creating a connection to emitter.io service.
var emitter = new Emitter.Connection(host, port);
var channelKey = "";
// Connect to emitter.io service
emitter.Connect();
// Handle chat messages
emitter.On(channelKey, "chat", (channel, msg) =>
{
Console.WriteLine(Encoding.UTF8.GetString(msg));
});
// Publish messages to the 'chat' channel
string text = "";
Console.WriteLine("Type to chat or 'q' to exit...");
do
{
text = Console.ReadLine();
emitter.Publish(channelKey, "chat", text);
}
while (text != "q");
// Disconnect the client
emitter.Disconnect();
```
To generate a channel key using the secret key provided, the `GenerateKey` method can be used.
```
// Generate a read-write key for our channel
emitter.GenerateKey(
"",
"chat",
Messages.EmitterKeyType.ReadWrite,
(response) => Console.WriteLine("Generated Key: " + response.Key)
);
```