Add an examples.md file...

[ruicaramalho]

Hi maybe you could have an examples.md file. People could help adding examples !!?

My contribution...

---

Send a Fire and forget Message

Connects to XMPP Server and send's a Message.
Replace Log... method for what ever you desire.

        /// <summary>
        /// Send XMMP Message and close. Can be used in service Tasks
        /// </summary>
        /// <param name="toUser"></param>
        /// <param name="message"></param>
        public static void ServiceSend(string toUser, string message)
        {

            string server = Parameter.GetStringValue("XMMPServer");
            string user = Constant.XMPPUser;
            string pass = Constant.XMPPPass;

            JID tojid; JID servjid;

            try
            {
                tojid = new JID()
                {
                    User = toUser,
                    Domain = server
                };

                servjid = new JID()
                {
                    User = user,
                    Domain = server,
                    Resource = Environment.MachineName
                };

                //xmppClient = new XmppWebSocketConnection(new JID(jid), password); // for WebSocket
                xmppClient = new SharpXMPP.XmppClient(servjid, pass, false);

                // Handler for all traffic
                xmppClient.Element += (sender, e) =>
                {

#if DEBUG           // For Debug write all msg exchanges
                    var direction = e.IsInput ? "<==" : "==>";
                    System.Diagnostics.Debug.WriteLine($"{direction} {e.Stanza}");
#endif

                    XElement stanzaXml = e.Stanza;

                    /* <== 
                    <failure xmlns="urn:ietf:params:xml:ns:xmpp-sasl">
                      <not-authorized />
                    </failure>
                    */
                    // -------- Wrong user or Pass return from OpenFire ----------
                    if (stanzaXml.Name.LocalName.Equals("failure"))
                    {
                        foreach (XElement descts in stanzaXml.Descendants())
                        {
                            if (descts.Name.LocalName.Equals("not-authorized"))
                            {
                                Log.Warn($"Wrong user: '{user}' or password");
                            }
                        }
                    }
                };

                // Signed Handler if OK sends message
                xmppClient.SignedIn += (sender, args) =>
                {
                    Log.Debug("Connected!");
                    xmppClient.Send(new Message
                    {
                        From = servjid.FullJid,
                        To = tojid.FullJid,
                        Text = message
                    });
                    Log.Debug("Message Send");
                };

                // Connection Handler Log Response
                xmppClient.ConnectionFailed += (sender, args) =>
                {
                    Log.Debug("Connection Failed!");
                    Log.Warn(args.Message);
                };

                // Task Async
                Task connection = xmppClient.ConnectAsync();

                // Wait 5 Sec for connection
                if (!connection.Wait(5000))
                {
                    Log.Warn($"Could not connect '{server}'! (5sec timeout)");
                }

            }
            catch (Exception)
            {
                throw;
            }
            finally
            {
                // Safe code, but not necessary. Connection shoud be null by now
                if (xmppClient != null)
                    if (xmppClient.ConnectionStream!=null)
                        xmppClient.Close();

            }


        }

    }

[vitalyster]

I'm not sure we need to duplicate code examples in .md files, they will be outdated and we may need to do an x2 extra work to maintain them. If you think real examples are not self-explanatory - feel free to send pull requests with comments and other improvements.

[vitalyster]

Also we can improve the main README file to point into correct example files. Pull requests are welcomed :)

[ruicaramalho]

I understand your point... but maybe a small example made by you in the readme.md file. It would help people to chose this solution.
Looking at the code people can quicly understand how easy it is, the existance ot handlers, the existance of the XMPPIq, XMPPMessage , etc. I Almost did not pick your code because of this :(

[vitalyster]

What is the problem to look at the actual code and why do we need to copy it into .md? What is next? Google Doc maybe? This library is for people who know what to do with it and how to read the code.

[ruicaramalho]

No problem, but looking at first page takes a few seconds, opening the code will take much more time and demands more concentration... It helps to sees an example.. And the maintence for a small example in opening readme.md will not be so hard.
But it's just my opinion I maybe wrong :)

[ruicaramalho]

Also we can improve the main README file to point into correct example files. Pull requests are welcomed :)

Yes it's also a great idea.