D 2012-10-31T06:40:43.167 L Embedding P 2688e2d3574da610c2fe5aeada8075c99f1f9014 U gerald W 3292

Loading the Webservices Server Package

To load the webservices server package, do:

 package require WS::Embedded

This command will only load the server the first time it is used, so it causes no ill effects to put this in each file declaring a service or service procedure.

Specify a Port to Receive Request on

Procedure Name : ::WS::Embeded::Listen

Description : Instruct the module to listen on a Port, security information.

Arguments : this procedure uses position dependent arguments, they are:

     port     -- Port number to listen on.
     certfile -- Name of the certificate file. Defaults to {}.
     keyfile  -- Name of the key file. Defaults to {}.
     userpwds -- A list of username and passwords. Defaults to {}.
     realm    -- The seucrity realm. Defaults to {}.
     logger   -- A logging routines for errors. Defaults to ::WS::Embeded::logger.

Returns : Handle of socket

Side-Effects : None

Exception Conditions : : None

Pre-requisite Conditions : None

Start Listening for Requests

Procedure Name : ::WS::Embeded::Start

Description : Start listening on all ports (i.e. enter the event loop).

Arguments : None

Returns : Value that event loop was exited with.

Side-Effects : Nothing

Exception Conditions : None

Pre-requisite Conditions :

::WS::Embeded::Listen should have been called for one or more port.

Stop Listening for Requests

Procedure Name : ::WS::Embeded::Stop

Description : Stop listening on all ports (i.e. enter the event loop).

Arguments :

    value -- Value that ::WS::Embedded::Start should return

Returns : Nothing