Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Dancer::RPCPlugin::DisUserhContributed PeDancer::RPCPlugin::DispatchFromPod(3)

NAME
       Dancer::RPCPlugin::DispatchFromPod - Build dispatch-table from POD

SYNOPSIS
	   use Dancer::Plugin;
	   use Dancer::RPCPlugin::DispatchFromPod;
	   sub dispatch_call {
	       return dispatch_table_from_pod(%parameters);
	   }

DESCRIPTION
       Interface to build a (partial) dispatch table from the special pod-
       directives in the packages specified and	for the	optional endpoint
       specified.

   POD Specifications
       One can specify a sub/method to be used for the RPCPlugin by using the
       POD directive "=for" followed by	the rpc-protocol supported by this
       plugin-set.  One	of jsonrpc, restrpc and	xmlrpc.

	   =for	<protocol> <rpc-name> <real-code-name>[	<endpoint>]

       <protocol> must be one of <jsonrpc|restrpc|xmlrpc>
       <rpc-name> is the name used by the rpc-interface	to execute this	call,
       different protocols may use diffent 'rpc-name's to reflect the nature
       of the protocol.
       <real-code-name>	is the name of the sub/method
       <endpoint> this optional	argument is needed for files/packages that
       have code for different endpoints.

       The pod-directive must be in the	same file the code it refers to	is.

       Make sure the partial dispatch table for	a single endpoint is build in
       a single	pass.

EXPORTS
   dispatch_table_from_pod(%arguments)
       Parameters

       Named:

       plugin => <jsonrpc|restrpc|xmlrpc>
       packages	=> [ $package_name, ...	]
       endpoint	=> '/endpoint_for_dispatch_tabledispatch_table'

       Responses

       A (partial) dispatch-table.

COPYRIGHT
       (c) MMXV	- Abe Timmerman	<abeltje@cpan.org>

perl v5.32.1			  2018-06Dancer::RPCPlugin::DispatchFromPod(3)

NAME | SYNOPSIS | DESCRIPTION | EXPORTS | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Dancer::RPCPlugin::DispatchFromPod&sektion=3&manpath=FreeBSD+13.1-RELEASE+and+Ports>

home | help