perlancar

NAME

peri-sockserve - Serve Perl modules using Riap::Simple protocol over sockets

VERSION

This document describes version 0.21 of peri-sockserve (from Perl distribution Perinci-Access-Simple-Server), released on 2015-03-05.

SYNOPSIS

 # serve modules
 % peri-sockserve -p 127.0.0.1:5678 -s /path/to/unix/sock Foo::Bar Baz::*

 # access the server
 % perl -MPerinci::Access -e'
     my $pa = Perinci::Access->new;
     my $res = $pa->request(call=>"riap+tcp://localhost:5678/Foo/Bar/func1",
                            {args=>{a1=>1, a2=>2}});'
     my $res = $pa->request(meta=>"riap+tcp:path/to/unix/sock//Baz/Qux/func2");'

 # see more options
 % peri-sockserve --help

DESCRIPTION

This is a simple command-line front-end for Perinci::Acces::Simple::Server::Socket, for making Perl modules accessible over TCP or Unix socket, using the Riap::Simple protocol. First the specified Perl modules will be loaded. Modules which do not contain Rinci metadata will be equipped with metadata using Perinci::Sub::Gen::ForModule. Perl modules not specified in the command-line arguments will not be accessible, since Perinci::Access::Perl is used with load=>0.

Modules can be accessed with Riap clients such as Perinci::Access using URL:

 riap+tcp://HOST:PORT/MODULE/SUBMOD/FUNCTION
 riap+unix:UNIX_SOCKET_PATH//MODULE/SUBMOD/FUNCTION

OPTIONS

* marks required options.

--access-log-path=s

Path for access log file.

Default is ~/peri-sockserve-access.log

--config-path=s

Set path to configuration file.

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

--daemonize, -D

If true, will daemonize into background.

--format=s

Choose output format, e.g. json, text.

--help, -h, -?

Display this help message.

--json

Set output format to json.

--library-json=s, -I

Add directory to library search path, a la Perl's -I (JSON-encoded).

See --library.

--library=s@

Add directory to library search path, a la Perl's -I.

Can be specified multiple times.

--modules-json=s

List of modules to load (JSON-encoded).

See --modules.

--modules=s@*

List of modules to load.

Either specify exact module name or one using wildcard (e.g. 'Foo::Bar::*', in which Module::List will be used to load all modules under 'Foo::Bar::').

Can be specified multiple times.

--naked-res

When outputing as JSON, strip result envelope.

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

    [200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

    [1,2,3]
--no-config

Do not use any configuration file.

--no-fork
--ports=s, -p

Will be passed to Perinci::Access::Simple::Server::Socket.

--unix-sockets=s, -s

Will be passed to Perinci::Access::Simple::Server::Socket.

--version, -v

ENVIRONMENT

PERI_SOCKSERVE_OPT

FILES

~/peri-sockserve.conf

/etc/peri-sockserve.conf

SEE ALSO

Riap::Simple, Riap, Rinci

Perinci::Access::Simple::Client, Perinci::Access

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

 complete -C peri-sockserve peri-sockserve

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using shcompgen) at installation time, so you can immadiately have tab completion.

tcsh

To activate tcsh completion for this script, put:

 complete peri-sockserve 'p/*/`peri-sockserve`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Perinci-Access-Simple-Server.

SOURCE

Source repository is at https://github.com/perlancar/perl-Perinci-Access-Simple-Server.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci-Access-Simple-Server

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.