use v6;
unit module Net::OSC::Transport::TCP;
use Net::OSC::Message;



head

There are a variety of methods for transmitting OSC over TCP.
This module provides routines sending your OSC messages with Length-prefixed message framing
  and SLIP message framing. See the individual subroutine descriptions for more details.


#
# When doing OSC over TCP, we have to do some sort of framing so that we can tell
# where one OSC packet ends and the next begins. There's many ways to do this
# framing, but the two methods below are commonly used.
#
# See http://forum.renoise.com/index.php/topic/43159-osc-via-tcp-has-no-framing
#

# Length-prefixed message framing
#
# This is used by SuperCollider.
#
sub send-lp(IO::Socket::INET $socket, Net::OSC::Message $message) is export
#= Sends an OSC message with Length-prefixed framing.
#= This is known to be used in SuperCollider.
{
  my Int $i = $message.package.elems;
  $socket.write(Buf.new(($i+>24) +& 0xFF, ($i+>16) +& 0xFF, ($i+>8) +& 0xFF, $i +& 0xFF));
  $socket.write($message.package);
}

sub recv-lp(IO::Socket::INET $socket --> Net::OSC::Message) is export
#= A subroutine for receiving Length-prefixed messages.
#= This routine blocks until it has recieved a complete message.
{
  my Buf $p = $socket.read(4);
  my Buf $b = $socket.read(($p[0]+<24) +| ($p[1]+<16) +| ($p[2]+<8) +| $p[3]);
  Net::OSC::Message.unpackage($b)
}


# SLIP message framing
#
# see https://en.wikipedia.org/wiki/Serial_Line_Internet_Protocol
#
# This is used by PureData.
#

sub send-slip(IO::Socket::INET $socket, Net::OSC::Message $message) is export
#= Sends an OSC message with SLIP framing.
#= This is known to be used in PureData.
{
  my @list = [];
  for $message.package.list {
    when 0xC0 { @list.append: 0xDB, 0xDC; }
    when 0xDB { @list.append: 0xDB, 0xDD; }
    default   { @list.append: $_; }
  }
  @list.append: 0xC0;
  $socket.write(Buf.new(@list));
}

sub recv-slip(IO::Socket::INET $socket --> Net::OSC::Message) is export
#= A subroutine for receiving SLIP messages.
#= This routine blocks until it has recieved a complete message.
{
  my @list = [];
  loop {
    given $socket.read(1)[0] {
      when 0xC0 { last; }
      when 0xDB {
        given $socket.read(1)[0] {
          when 0xDC { @list.append: 0xC0; }
          when 0xDD { @list.append: 0xDB; }
          default { die 'this should never happen'; }
        }
      }
      default { @list.append: $_; }
    }
  }
  Net::OSC::Message.unpackage(Buf.new(@list));
}


root

Types

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


Net::OSC::Transport::TCP

subroutines