head

Net::OSC::Server - A role to facilitate a convenient platform for OSC communication.


code

=begin code
method new(:$!is64bit = True)
=end code


Set :is64bit to false to force messages to be packed to 32bit types
 this option may be required to talk to some versions of Max and other old OSC implementations.



unit role Net::OSC::Server;
use Net::OSC::Message;
use Net::OSC::Types;

has ActionTuple @!dispatcher;
has Bool        $.is64bit = True;

multi method actions( --> Seq)
#= Lists the actions managed by this server.
#= Actions are expressed as a list holding a Regex and a Callable object.
#= Upon receiving a message the server tries to match the path of the OSC message with the Regex of an action.
#= All actions with a matching Regex will be executed.
#= the Callable element of an action is called with a Net::OSC::Message and a Match object.
{
  @!dispatcher.values
}

method add-action(Regex $path, Callable $action)
#= Add an action for managing messages to the server.
#= See the actions method description above for details and the add-actions method below for the plural expression.
{
  @!dispatcher.push: $($path, $action);
}

method add-actions(*@actions)
#= Add multiple actions for managing messages to the server.
#= See the actions method description above for details.
{
  for @actions -> $action {
    die "Actions must be provided as a tuple of format: (Regex, Callable), recieved ({ $action.WHAT.perl })!" unless $action ~~ ActionTuple;
    @!dispatcher.push: $action;
  }
}

method send(OSCPath $path, *%params)
#= Send and OSC message.
#= The to add arguments to the message pass :args(...), after the OSC path string.
#= Implementing classes of the Server role may accept additional named parameters.
{
  self.transmit-message(Net::OSC::Message.new(
    :$path
    :args( (%params<args>:exists and %params<args>.defined) ?? %params<args> !! () )
    :is64bit($!is64bit)
  ))
}

method !on-message-recieved(Net::OSC::Message $message)
#= Dispatch a message to actions with an accepting path constraint
{
  for @!dispatcher -> $action {
    given $message.path {
      when $action[0] {
        $action[1]($message, $/)
      }
      default {
        next;
      }
    }
  }
}

method close()
#= Call the server's on-close method.
#= This will call the server implementations on-close hook.
{
  self!on-close();
}

method !listen()
#= Start listening for OSC messages
{ ... }

method !on-close()
#= Clean up listener and sender objects
{ ... }

multi method transmit-message(Net::OSC::Message:D $message)
#= Transmit an OSC message.
#= This method must be implemented by consuming classes.
#= implementations may add additional signatures.
#= Use this method to send a specific OSC message object instead of send (which creates one for you).
{ ... }


root

Message

React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


Server

NAME

METHODS