dataweasel/sharp.xmpp

Sharp.Xmpp is looking for a maintainer! Unfortunatelly I do not have currently the time needed to maintain the library. Luckily a small but vibrant community has evolved around Sharp.Xmpp. If you would like to be the project's maintainer please sent an email to [email protected]. This should include issues, tickets and commits that you have done for Sharp.Xmpp or other similar project. Sharp.Xmpp is a multiplatform, Windows and Android, .NET XMPP client assembly.Sharp.Xmpp supports IM functionality & a variety of XMPP extensions, is simple and is extensively tested against Android Xamarin. It is a fork of the currently frozen excellent S22.Xmpp project. Sharp.Xmpp will be at the FOSSDEM 2016 Real time DevRoom!

Introduction

This repository contains an easy-to-use and well-documented .NET assembly for communicating with an XMPP server. It supports basic Instant Messaging and Presence funtionality as well as a variety of XMPP extensions.

Supported XMPP Features

The library fully implements the XMPP Core and XMPP IM specifications and thusly provides the basic XMPP instant messaging (IM) and presence functionality. In addition, the library offers support for most of the optional procotol extensions. More specifically, the following features are supported:

• SASL Authentication (PLAIN, DIGEST-MD5, and SCRAM-SHA-1)
• User Avatars
• SOCKS5 and In-Band File-Transfer
• In-Band Registration
• User Mood
• User Tune
• User Activity
• Simplified Blocking
• API designed to be very easy to use
• Well documented with lots of example code
• Free to use in commercial and personal projects (MIT License)

Where to get it

You can always get the latest binary package on Nuget or download the binaries as a .zip archive from GitHub. The documentation is also available for offline viewing as HTML or CHM and can be downloaded from here and here, respectively.

Usage & Examples

To use the library add the S22.Xmpp.dll assembly to your project references in Visual Studio. Here's a simple example that initializes a new instance of the XmppClient class and connects to an XMPP server:

using System;
using S22.Xmpp;
using S22.Xmpp.Client;

namespace Test {
	class Program {
		static void Main(string[] args) {
			/* connect on port 5222 using TLS/SSL if available */
			using (var client = new XmppClient("jabber.se", "username", "password"))
			{
				Console.WriteLine("Connected as " + client.Jid);
			}
		}
	}
}

Please see the documentation for a getting started guide, examples and details on using the classes and methods exposed by the S22.Xmpp assembly.

Credits

The Sharp.Xmpp library is copyright © 2015 Panagiotis Georgiou Stathopoulos. The initial S22.Xmpp library is copyright © 2013-2014 Torben Könke.

License

This library is released under the MIT license.

Bug reports

Please send your bug reports to [email protected] or create a new issue on the GitHub project homepage.