[Home] [Downloads] [Search] [Help/forum]

Gammon Software Solutions forum

See www.mushclient.com/spam for dealing with forum spam. Please read the MUSHclient FAQ!

[Folder]  Entire forum
-> [Folder]  MUSHclient
. -> [Folder]  Suggestions
. . -> [Subject]  Plugin broadcast.
Home  |  Users  |  Search  |  FAQ
Username:
Register forum user name
Password:
Forgotten password?
(New message)
Subject: Plugin broadcast.
Name:
Your forum user name.
Register forum user name
Password:
Your forum password.
Forgotten password?
Message:
Message to be posted (in English, please).
Forum codes:
Check this if your message uses 'forum codes' or templates (auto-detected for new posts).
Forum codes Templates

Save this message ...

Subject review (reverse sequence)

Pages: 1 2  

Posted by Poromenos   Greece  (1,037 posts)  [Biography] bio
Date Sat 15 Oct 2005 01:47 AM (UTC)  [ quote  ]
Message
Ah, that is great. I think it will make the plugin system much more flexible and useful.
Vidi, Vici, Veni.
http://porocrom.poromenos.org/ Read it!
[Go to top] top
Posted by Nick Gammon   Australia  (18,770 posts)  [Biography] bio   Forum Administrator
Date Sat 15 Oct 2005 01:44 AM (UTC)  [ quote  ]
Message
This idea is now incorporated into version 3.67. Any plugin (or main script file) can do a BroadcastPlugin script call.

This will attempt to find an OnPluginBroadcast handler in all installed plugins.

If found, the handler is called with 4 arguments, two that you supply (a number and a string), and 2 automatically generated, which identify the calling plugin ID and name.

The intention of those arguments is to make sure that the plugin broadcast comes from the plugin that you are expecting.
- Nick Gammon

www.gammon.com.au, www.mushclient.com
[Go to top] top
Posted by Poromenos   Greece  (1,037 posts)  [Biography] bio
Date Thu 08 Sep 2005 11:32 PM (UTC)  [ quote  ]
Message
Here's the broadcast plugin:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE muclient>
<!-- Saved on Thursday, June 05, 2003, 9:00 PM -->
<!-- MuClient version 3.42 -->

<muclient>
<plugin
   name="Broadcast"
   author="Poromenos"
   id="e58a316339d27af6ddc6bd3c"
   language="VBscript"
   purpose="Broadcasts data."
   save_state="y"
   date_written="2003-06-05 21:00:18"
   requires="3.42"
   version="1.0"
   >

</plugin>


<!--  Script  -->


<script>
<![CDATA[
Sub sbBroadcast(strData)
    Dim lstPlugins
    lstPlugins = GetPluginList
    If Not IsEmpty (lstPlugins) Then
        For Each plPlugin In lstPlugins
            strPluginID = GetPluginInfo (plPlugin, 7)
            If World.PluginSupports (strPluginID, "OnPluginBroadcast") = eOK then
                CallPlugin GetPluginInfo (plPlugin, 7), "OnPluginBroadcast", strData
            End If
        Next
    End If
End Sub]]>
</script>

</muclient>


And here's how to use it:


def fnBroadcast(strData):
    if (world.PluginSupports("e58a316339d27af6ddc6bd3c", "sbBroadcast") == eOK):
        world.CallPlugin("e58a316339d27af6ddc6bd3c", "sbBroadcast", "%s|%s" % (world.GetPluginName, strData))

def OnPluginBroadcast(strData):
    # Do something with the data.
    pass
Vidi, Vici, Veni.
http://porocrom.poromenos.org/ Read it!
[Go to top] top
Posted by Poromenos   Greece  (1,037 posts)  [Biography] bio
Date Mon 22 Aug 2005 11:32 PM (UTC)  [ quote  ]
Message
God, I hope I don't have to bump this again. It's been a few months since I posted initially.
Vidi, Vici, Veni.
http://porocrom.poromenos.org/ Read it!
[Go to top] top
Posted by Flannel   USA  (1,230 posts)  [Biography] bio
Date Fri 17 Jun 2005 09:36 PM (UTC)  [ quote  ]
Message
He posted two days ago (on the 15th), in the programming forum. For the past month now, he's posted a total of thrice; each about two weeks apart.

I agree, it isn't normal of him, but I'm sure he's just busy or something.
~Flannel

Messiah of Rose
Eternity's Trials.

Clones are people two.
[Go to top] top
Posted by Poromenos   Greece  (1,037 posts)  [Biography] bio
Date Fri 17 Jun 2005 07:43 PM (UTC)  [ quote  ]
Message
I'm beginning to worry about Nick... He hasn't posted in a month and he used to check the forums every day... Anyone know where he is?
Vidi, Vici, Veni.
http://porocrom.poromenos.org/ Read it!
[Go to top] top
Posted by Tsunami   USA  (204 posts)  [Biography] bio
Date Wed 25 May 2005 02:06 PM (UTC)  [ quote  ]
Message
I definately agree with Poromenos. Back when I was getting started with MC, I expected that the plugins would be able to work like this so I made mine very modular. One for healing, one for fighting, one for anti-theft, etc... Then I started to realize however that all of them depended on some of the same constants (I play IRE, so balance, eq, etc..) It was inefficient to have each plugin try and catch these and react to them on their own, especially since then they would be competing with each other for execute precendence instead of working together. In the end, I just solved it by putting everything in one big plugin so they could share variables etc... This idea would go a long way towards a more modularized approach, and I especially like the idea of being able to work with other peoples plugins in a much more 'oop' way if you like.
[Go to top] top
Posted by Poromenos   Greece  (1,037 posts)  [Biography] bio
Date Wed 25 May 2005 (UTC)  [ quote  ]
Message
I feel that this feature is not only useful, but essential for having plugins that work as intended, and I'm surprised noone suggested it before. I think plugins were designed and are supposed to work like this.
Vidi, Vici, Veni.
http://porocrom.poromenos.org/ Read it!
[Go to top] top
Posted by Poromenos   Greece  (1,037 posts)  [Biography] bio
Date Tue 24 May 2005 11:57 PM (UTC)  [ quote  ]
Message
Well, as for the world, the callback could be added, like the rest of the callbacks. Also, "message system" makes it sound more complicated that it is, it's just a loop that does "CallPlugin 'x', 'OnPluginBroadcast', data".

By the way, the plugin implementation is:

Sub sbBroadcast(strData)
    Dim lstPlugins
    lstPlugins = GetPluginList
    If Not IsEmpty (lstPlugins) Then
      For Each plPlugin In lstPlugins
         CallPlugin GetPluginInfo (plPlugin, 7), "OnPluginBroadcast", strData
      Next
    End If
End Sub


But it's easy to implement, useful and having it rely on one plugin that would mess everything up if it wasn't installed is too big a price to pay.
Vidi, Vici, Veni.
http://porocrom.poromenos.org/ Read it!
[Go to top] top
Posted by Flannel   USA  (1,230 posts)  [Biography] bio
Date Tue 24 May 2005 11:50 PM (UTC)  [ quote  ]

Amended on Tue 24 May 2005 11:54 PM (UTC) by Flannel

Message
Yeah, it would allow for plugins to become modular. Like I was saying earlier (hmm, maybe I deleted it, no there it is, at the end), you can have a set of plugins that does all of the stuff behind the scenes, and then you just need to include a plugin to localize it to a server (triggers to catch things, and skeleton command aliases to reply).

Problem with making it a plugin callback is that then we would force it to be a plugin only thing.
Having an interface with the world would be handy so I could have my aforementioned localization stuff be in my world file, instead of my plugin.
Actually, I suppose the localization would be better suited for a plugin, since chances are you'd be distributing it, but you get the idea.

I know this is going to be a great improvement for plugins, I'm just not sure that it should become its own message system.
~Flannel

Messiah of Rose
Eternity's Trials.

Clones are people two.
[Go to top] top
Posted by Poromenos   Greece  (1,037 posts)  [Biography] bio
Date Tue 24 May 2005 10:22 PM (UTC)  [ quote  ]
Message
Come to think of it, this would allow for plugin separation. For example, I have a plugin to fight that also heals. If this was implemented I could have a healing plugin that broadcast "Done healing", the fighting plugin would receive that and resume fighting. I could then remove the fighting plugin and replace it with another plugin that worked off healing without changing any of the code. Another user could make one plugin that worked with my healing one without having to change mine.
Vidi, Vici, Veni.
http://porocrom.poromenos.org/ Read it!
[Go to top] top
Posted by Poromenos   Greece  (1,037 posts)  [Biography] bio
Date Tue 24 May 2005 08:01 PM (UTC)  [ quote  ]
Message
There would be an OnPluginBroadcast function that returned the broadcast text. The plugin name thing is just an example, you could just broadcast "Dest_reached" or whatever. Also, the only plugin that has to know the plugin name to listen to is the plugin you are making, and you probably already know what you want to listen to. Using execute would be slower, since you would have to evaluate all the aliases, and generally it would pass through several systems it doesn't need to.
Vidi, Vici, Veni.
http://porocrom.poromenos.org/ Read it!
[Go to top] top
Posted by Flannel   USA  (1,230 posts)  [Biography] bio
Date Tue 24 May 2005 07:56 PM (UTC)  [ quote  ]

Amended on Tue 24 May 2005 07:59 PM (UTC) by Flannel

Message
How would a listener listen then?

Theyd have to be listening for specific messages (with an arbitrary name prefix)? or just for messages from certain plugins?

You can broadcast with execute, and include a null route in your own plugin, if you're going to include the plugin name in each message. Although I think including a plugin name (as a prefix) is a bit clumsy, since you'll be forcing each plugin to know which other plugins it needs to listen to (or have things that listen for *:* if theyre listening for multiple messages from multiple plugins, which seems like a lot of extra computation with all the other messages and other plugins).
~Flannel

Messiah of Rose
Eternity's Trials.

Clones are people two.
[Go to top] top
Posted by Poromenos   Greece  (1,037 posts)  [Biography] bio
Date Tue 24 May 2005 07:48 PM (UTC)  [ quote  ]
Message
UDP would be too messy, yes, especially if the port was in use... I also recall the handler plugin, although I would prefer if I didn't have to use one. I think it would be a nice feature and relatively easy for Nick to add, and many people could benefit from it. The execute approach doesn't work very well because I really don't want to have to change the sender plugin to that extent. If there was a broadcast command, plugins could broadcast "Pluginname: Dest_reached" or something and not care if anyone was listening, they could do it just in case. I believe this is a very useful feature, since the plugin architecture allows for (and encourages) plugins to cooperate to do one job, but there aren't really any universal functions to help plugins do that.
Vidi, Vici, Veni.
http://porocrom.poromenos.org/ Read it!
[Go to top] top
Posted by Flannel   USA  (1,230 posts)  [Biography] bio
Date Tue 24 May 2005 07:29 PM (UTC)  [ quote  ]

Amended on Tue 24 May 2005 07:34 PM (UTC) by Flannel

Message
Actually, You could just prefix all of your executes with something, and then have one generic alias that catches those, and doesn't send anything (with a high sequence).
Just a fall through that throws the command out.

The prefix is only needed because it means you only need one alias to toss it out.
I suppose we could ask nick for an option (either a flag, or a new sendto) that acts as an execute command, but never, under any circumstances, gets sent to the server, but that seems like a lot of work, for not a lot of gain. (Unless there are other advantages?)
~Flannel

Messiah of Rose
Eternity's Trials.

Clones are people two.
[Go to top] top

The dates and times for posts above are shown in Universal Co-ordinated Time (UTC).

To show them in your local time you can join the forum, and then set the 'time correction' field in your profile to the number of hours difference between your location and UTC time.

6,791 views.

This is page 1, subject is 2 pages long: 1 2  [Next page]

[Reply to this subject]  Reply to this subject   [New subject]  Start a new subject   [Refresh] Refresh page

Go to topic:           Search the forum

[Go to top] top

[Home]

Written by Nick Gammon - 5K

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( http://www.gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Internet Contents Rating Association (ICRA) - 2K]    [Web site powered by FutureQuest.Net]