head

Lumberjack::Application::WebSocket - Lumberjack websocket provider


code

=begin code

use Lumberjack;
use Lumberjack::Dispatcher::Supply;
use Lumberjack::Application::WebSocket;

my $s = Lumberjack::Dispatcher::Supply.new;
Lumberjack.dispatchers.append: $s;

my &ws-app = Lumberjack::Application::WebSocket.new(supply => $s.Supply);

# You can of course use it anywhere a P6SGI app can be used:
HTTP::Server::Tiny.new(port => 8898).run(&ws-app);

=end code


This class provides a C<P6SGI> application that implements a
WebSocket server endpoint that will emit the C<Lumberjack::Message>s
that are received on the C<Supply> provided to the constructor.


The messages are emitted as a JSON serialised form and it is the
responsibility of the receiving clients to parse and interpret
as appropriate.  The structure that is used by the
C<Lumberjack::Dispatcher::Proxy> and is described (implemented
by,) C<Lumberjack::Message::JSON>.


It is the responsibility of the container application to locate
the endpoint appropriately, itself it is agnostic to which path
it is called at.


The class only has a constructor, with one required parameter
C<supply> which must be a Supply which will provide the
Lumberjack::Messages that will be sent out by the websocket
connect.  Typically this will be the C<Supply> of a 
C<Lumberjack::Dispatcher::Supply>.



use Lumberjack::Message::JSON;
use WebSocket::P6W;


class Lumberjack::Application::WebSocket does Callable {
    has Supply $.supply is required;

    method CALL-ME(%env) {
        self.call(%env);
    }

    method call(%env) {
        my $tap;
        my $supply = $!supply;
        my $closed-promise = Promise.new;
        ws-psgi(%env,
                on-ready => -> $ws {
                    $tap = $supply.tap(-> $got {
                        if $got !~~ Lumberjack::Message::JSON {
                            $got does Lumberjack::Message::JSON;
                        }
                        if $closed-promise.status ~~ Planned {
                            try $ws.send-text( $got.to-json );
                        }
                    });
                },
                on-text => -> $ws, $txt {
                    # Not expecting anything back
                },
                on-binary => -> $ws, $binary {
                    # Not expecting anything back
                },
                on-close => -> $ws {
                        $closed-promise.keep: "GOT CLOSE";
                        $tap.close if $tap;
                },
        );
    }
}
# vim: expandtab shiftwidth=4 ft=raku


root

Proxy

PSGI

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


WebSocket

NAME

SYNOPSIS

DESCRIPTION

METHODS

method new

Lumberjack::Application v0.0.10

Authors

License

Dependencies

Test Dependencies

Provides

Documentation