peri-sockserve - Serve Perl modules using Riap::Simple protocol over sockets
This document describes version 0.25 of peri-sockserve (from Perl distribution Perinci-Access-Simple-Server), released on 2017-07-03.
# 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
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
* marks required options.
*
Path for access log file.
Default is ~/peri-sockserve-access.log
If true, will daemonize into background.
Add directory to library search path, a la Perl's -I (JSON-encoded).
See --library.
--library
Add directory to library search path, a la Perl's -I.
Can be specified multiple times.
List of modules to load (JSON-encoded).
See --modules.
--modules
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::').
Will be passed to Perinci::Access::Simple::Server::Socket.
Set path to configuration file.
Set configuration profile to use.
Do not use any configuration file.
Do not read environment for default options.
Choose output format, e.g. json, text.
Default value:
undef
Set output format to json.
When outputing as JSON, strip result envelope.
0
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]
Display help message and exit.
Display program's version and exit.
This script has shell tab completion capability with support for several shells.
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 immediately have tab completion.
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).
For fish and zsh, install shcompgen as described above.
This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.
By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/peri-sockserve.conf, ~/peri-sockserve.conf, or /etc/peri-sockserve.conf.
--config-path
All found files will be read and merged.
To disable searching for configuration files, pass --no-config.
--no-config
You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.
[profile=SOMENAME]
[SOMESECTION profile=SOMENAME]
--config-profile SOMENAME
You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.
program=NAME
[program=NAME ...]
[SOMESECTION program=NAME]
Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.
env=CONDITION
[env=SOMEVAR ...]
[SOMESECTION env=SOMEVAR ...]
[env=HOSTNAME=blink ...]
[SOMESECTION env=HOSTNAME=blink ...]
[env=HOSTNAME!=blink ...]
[SOMESECTION env=HOSTNAME!=blink ...]
[env=HOSTNAME*=server ...]
[SOMESECTION env=HOSTNAME*=server ...]
List of available configuration parameters:
access_log_path (see --access-log-path) daemonize (see --daemonize) fork (see --no-fork) format (see --format) library (see --library) modules (see --modules) naked_res (see --naked-res) ports (see --ports) unix_sockets (see --unix-sockets)
Specify additional command-line options.
~/.config/peri-sockserve.conf
~/peri-sockserve.conf
/etc/peri-sockserve.conf
Please visit the project's homepage at https://metacpan.org/release/Perinci-Access-Simple-Server.
Source repository is at https://github.com/sharyanto/perl-Perinci-Access-Simple-Server.
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.
Riap::Simple, Riap, Rinci
Perinci::Access::Simple::Client, Perinci::Access
perlancar <perlancar@cpan.org>
This software is copyright (c) 2017, 2015, 2014, 2013, 2012 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.
To install Perinci::Access::Simple::Server, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Perinci::Access::Simple::Server
CPAN shell
perl -MCPAN -e shell install Perinci::Access::Simple::Server
For more information on module installation, please visit the detailed CPAN module installation guide.