| Shuyi Chen | 8f4ce9e | 2013-05-22 13:10:40 -0700 | [diff] [blame] | 1 | aSmack README |
| 2 | ============= |
| 3 | |
| 4 | Version: $VERSION_TAG |
| 5 | Build date: $BUILD_DATE |
| 6 | |
| 7 | Important Notes |
| 8 | =============== |
| 9 | |
| 10 | Read this, or aSmack won't work for you! |
| 11 | |
| 12 | Static Code |
| 13 | ----------- |
| 14 | |
| 15 | In order to work correctly on Android, you need to register Smack's |
| 16 | XMPP Providers and Extensions manually and init some static code |
| 17 | blocks before you doing any XMPP activty. Calling |
| 18 | SmackAndroid.init(Context) (in org.jivesoftware.smack) will do this |
| 19 | for you. |
| 20 | |
| 21 | ConnectionConfiguration |
| 22 | ----------------------- |
| 23 | |
| 24 | Please use the provided AndroidConnectionConfiguration class if |
| 25 | possible to create a new connection. |
| 26 | |
| 27 | Compression |
| 28 | ----------- |
| 29 | |
| 30 | If you want compressed XMPP streams you have to add |
| 31 | [jzlib-1.0.7](http://www.jcraft.com/jzlib/) to your project. Note that |
| 32 | every version higher then 1.0.7 wont work. |
| 33 | More Info: https://github.com/Flowdalic/smack/issues/12 |
| 34 | |
| 35 | Problems / Debugging |
| 36 | ============================== |
| 37 | |
| 38 | aSmack Wiki |
| 39 | ----------- |
| 40 | |
| 41 | More information about XMPP File Transfers, SSL Certificates and other |
| 42 | stuff related to aSmack can be found in the wiki: |
| 43 | https://github.com/Flowdalic/asmack/wiki |
| 44 | |
| 45 | How to debug your problem |
| 46 | ------------------------- |
| 47 | |
| 48 | We always provide source zips. Attach them to the jar in your favorite |
| 49 | IDE. Enable debugging mode with [BOSH|XMPP]Connection.DEBUG and |
| 50 | config.setDebug. See also: |
| 51 | http://www.igniterealtime.org/builds/smack/docs/latest/documentation/debugging.html |
| 52 | |
| 53 | Reporting a bug |
| 54 | --------------- |
| 55 | |
| 56 | Your issue should contain |
| 57 | 1. a logcat |
| 58 | 2. a server to reproduce |
| 59 | 3. the code you are using (for FOSS project we'll accept reposituroy URLs) |
| 60 | |
| 61 | If you record a logcat and make sure to remove your credentials |
| 62 | (usually a base64 block inside <auth></auth>). |
| 63 | |
| 64 | There is no guarantee that we will reply immediatly. But we will try |
| 65 | to investigate the problem. Feel free to join ##smack @ freenode and |
| 66 | ask for help (you may have to idle for some time before you get a |
| 67 | reply). |
| 68 | |
| 69 | Component Revision Information for this Release |
| 70 | =============================================== |
| 71 | |