NAME
peri-sockserve - Serve Perl modules using Riap::Simple protocol over sockets
VERSION
This document describes version 0.290 of peri-sockserve (from Perl distribution Perinci-Access-Simple-Server), released on 2021-08-01.
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 --helpDESCRIPTION
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/FUNCTIONOPTIONS
* marks required options.
Main options
- --access-log-path=s
-
Path for access log file.
Default is ~/peri-sockserve-access.log
- --daemonize, -D
-
If true, will daemonize into background.
- --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.Can also be specified as the 1st command-line argument and onwards.
- --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 also be specified as the 1st command-line argument and onwards.
Can be specified multiple times.
- --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.
Configuration options
- --config-path=s, -c
-
Set path to configuration file.
- --config-profile=s, -P
-
Set configuration profile to use.
- --no-config, -C
-
Do not use any configuration file.
Environment options
Output options
- --format=s
-
Choose output format, e.g. json, text.
Default value:
undef - --json
-
Set output format to json.
- --naked-res
-
When outputing as JSON, strip result envelope.
Default value:
0By 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] - --page-result
-
Filter output through a pager.
- --view-result
-
View output using a viewer.
Other options
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-sockservein 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 modules using cpanm-shcompgen which can activate shell completion for scripts immediately.
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.
CONFIGURATION FILE
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.
All found files will be read and merged.
To disable searching for configuration files, pass --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.
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.
You can also 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 equals some string: [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 some string: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when the value of an environment variable includes some string: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. If you only want a section to be read when the value of an environment variable does not include some string: [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.
To load and configure plugins, you can use either the -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [plugin=NAME ...] sections, for example:
[plugin=DumpArgs]
-event=before_validate_args
-prio=99
[plugin=Foo]
-event=after_validate_args
arg1=val1
arg2=val2which is equivalent to setting -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.
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)ENVIRONMENT
PERI_SOCKSERVE_OPT => str
Specify additional command-line options.
FILES
~/.config/peri-sockserve.conf
~/peri-sockserve.conf
/etc/peri-sockserve.conf
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.
SEE ALSO
Perinci::Access::Simple::Client, Perinci::Access
AUTHOR
perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2021, 2020, 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.