1
0
Fork 0
mirror of https://codeberg.org/Mercury-IM/Smack synced 2024-11-30 02:02:06 +01:00
Smack/documentation/overview.md

43 lines
1.8 KiB
Markdown
Raw Normal View History

2014-08-16 00:09:55 +02:00
Smack Overview
==============
2014-08-16 00:09:55 +02:00
[Back](index.md)
2014-08-16 00:09:55 +02:00
Smack is a library for communicating with XMPP servers to perform real-time
communications, including instant messaging and group chat.
Smack Key Advantages
--------------------
2014-08-16 00:09:55 +02:00
* Extremely simple to use, yet powerful API. Sending a text message to a user can be accomplished in only a few lines of code:
```java
AbstractXMPPConnection connection = new XMPPTCPConnection("mtucker", "password", "jabber.org");
2015-01-25 19:48:52 +01:00
connection.connect().login();
2017-01-03 08:55:14 +01:00
Message message = new Message("jsmith@jivesoftware.com", "Howdy! How are you?");
connection.sendStanza(message);
```
2014-08-16 00:09:55 +02:00
2017-01-03 08:55:14 +01:00
* Doesn't force you to code at the XMPP protocol level, as other libraries do. Smack provides intelligent higher level constructs such as the `Chat` and `Roster` classes, which let you program more efficiently.
2014-08-16 00:09:55 +02:00
* Does not require that you're familiar with the XMPP XML format, or even that you're familiar with XML.
* Provides easy machine to machine communication. Smack lets you set any number of properties on each message, including properties that are Java objects.
2017-01-03 08:55:14 +01:00
* Open Source under the Apache License 2.0, which means you can incorporate Smack into your commercial or non-commercial applications.
2014-08-16 00:09:55 +02:00
About XMPP
----------
2014-08-16 00:09:55 +02:00
XMPP (eXtensible Messaging and Presence Protocol) is an open protocol
standardized by the IETF and supported and extended by the XMPP Standards
2015-03-13 16:27:50 +01:00
Foundation (XSF, [http://www.xmpp.org](http://www.xmpp.org)).
2014-08-16 00:09:55 +02:00
How To Use This Documentation
-----------------------------
2014-08-16 00:09:55 +02:00
This documentation assumes that you're already familiar with the main features
of XMPP instant messaging. It's also highly recommended that you open the
Javadoc API guide and use that as a reference while reading through this
documentation.
Copyright (C) Jive Software 2002-2008