Iq Filters on Iq receive - Forum

johnm60

2010-07-01, 15:52 #1

Member since Jun 2010 · 32 posts
Group memberships: Members

Show profile ·

Link to this post

Subject: Iq Filters on Iq receive

Hi

I have built a few test applications and I am pretty happy so far. One thing that I do not feel I have a grip on is how to handle Iq's where the application is the service provider. If I send an Iq (as a client or service consumer), I can register a method that gets called when a response is returned.

var diq = new DispatcherIq
{
    Type = Matrix.Xmpp.IqType.get,
    To = item.DestinationJid + "/" + client.Resource,
    Dispatcher = new Dispatcher { SenderMAN = client.Username, RecipientMAN = item.DestinationJid, Filename = item.Filename }
};
client.IqFilter.SendIq(diq, DispatcherResponse);

which then returns a response to:

private void DispatcherResponse(object sender, Matrix.Xmpp.Client.IqEventArgs e)
{
      var iq = e.Iq;
      if (iq.Type == Matrix.Xmpp.IqType.result)
      {
      var dispatcher = iq.Element<Dispatcher>();
      if (dispatcher != null)
      {
      log("Got a dispatch response " + dispatcher.Filename);
      //do something interesting
      }
      }
}

At the other end of this, I process an OnIq event, with something like this:

void client_OnIq(object sender, IqEventArgs e)
{
      try //no parent calling function, so put a try catch block
      {
      if (e.Iq.Type == Matrix.Xmpp.IqType.get && e.Iq.Query is Dispatcher)
      {
      // this is now acting as a service provider from another client
      var dispatcher = e.Iq.Query as Dispatcher;
      //now send response
      var diq = new DispatcherIq
      {
      Id = e.Iq.Id, //used to correlate with the request !!!
      To = e.Iq.From,
      Type = Matrix.Xmpp.IqType.result,
      Dispatcher = new Dispatcher { Filename = dispatcher.Filename, MessageBody = "success"}
      };
      // send the response
      client.Send(diq);
      }
      }
      catch (Exception ex)
      {
      log("On_Iq error: " + ex.ToString());
      }
}

This is all fine, but if I have a BOT for instance that I want to respond to several types or classes of Iq, I end up with a complicated event handler that switches on the event type. This is OK, but a little unwieldy. I could create a dictionary of event type to method and register each of the event types and then the main Iq handler could then look up the event type and then delegate it the previously registered method. This would keep the OnIq handler tidy and there would then be a handler method for each type of Iq.

I strikes me that this is capability that could be in the Matrix client. Have I overlooked a capability that is already there? Or should I use a mechanism such as I described to manage this myself?

Thanks
John

Alex

2010-07-01, 23:19 #2

Member since Feb 2003 · 4449 posts · Location: Germany
Group memberships: Administrators, Members

Show profile ·

Link to this post

there is nothing like that currently in MatriX. I created a class for this for a customer project. I have to cleanup the code a bit and will share it with you here then.

Alex

Alex

2010-07-02, 13:06 #3

Member since Feb 2003 · 4449 posts · Location: Germany
Group memberships: Administrators, Members

Show profile ·

Link to this post

here is a small helper class for filtering incoming Iqs and raising the callbacks.

using System;
using System.Linq;
using System.Collections.Generic;
using Matrix.Xml;
using Matrix.Xmpp.Client;
 
namespace MiniClient
{
    public class CallbackFilter
    {
        private readonly List<FilterData> filters = new List<FilterData>();
        
        public CallbackFilter(XmppClient xmppClient)
        {
            xmppClient.OnIq += OnIq;    
        }
 
        void OnIq(object sender, IqEventArgs e)
        {
            foreach (FilterData data in filters)
            {
                var query = e.Iq.Query;
                if (query != null)
                {
                    if (query.GetType() == data.Type)
                        data.Callback.Invoke(sender, e);
                }
            }
        }
        
        public void RegisterCallback<T>(EventHandler<IqEventArgs> del) where T : XmppXElement
        {
            filters.Add(new FilterData {Type = typeof(T), Callback = del});
        }
 
        public void UnregisterCallback<T>() where T : XmppXElement
        {
            var f = filters.FirstOrDefault(fd => fd.Type.Equals(typeof (T)));
            if (f != null)
                filters.Remove(f);
            
        }
 
        class FilterData
        {
            public Type Type {get;set;}
            public EventHandler<IqEventArgs> Callback { get; set; }
        }
    }
}

here is an example how to use it.

private CallbackFilter cbf;
 
private void RegisterCallbacks())
{
    cbf = new CallbackFilter(xmppClient);
    cbf.RegisterCallback<Matrix.Xmpp.Roster.Roster>(RosterCallback);
    cbf.RegisterCallback<Matrix.Xmpp.Bind.Bind>(BindCallback);   
}
 
private void RosterCallback(object sender, IqEventArgs e)
{
}
 
private void BindCallback(object sender, IqEventArgs e)
{
}

Alex

johnm60

2010-07-02, 19:51 #4

Member since Jun 2010 · 32 posts
Group memberships: Members

Show profile ·

Link to this post

Thanks Alex

I will try this out on Monday in my application.

Regards
John