Library: Net, Web Services Broker (OMWSB) Import: omwsb.xmd

Return type: wbs.server Returns:  A wsb.server variable representing the newly created server.

Declaration

  export external server function create-server
    on                        value integer port
    of-type                   value integer type
    default-min-threads       value integer min-threads  optional initial {1}
    default-max-threads       value integer max-threads  optional initial {50}
    max-queue-length          value integer queue-length optional initial {25}
     timeout                  value integer   timeout     optional initial {2500}

Argument definitions

port

specifies the port number on which the server will run

type

specifies the type of server to create. Valid values are: soap-service, xmlrpc-service, and other-service

min-threads

defines the minimum number of threads to create for handling each service if not specified in the call to add-service

max-threads

defines the maximum number of threads to create for handling each service if not specified in the call to add-service

queue-length

defines the maximum number of unrecognized requests to queue. If more unrecognized requests are received when the queue is full, these additional requests are dropped.

timeout

The time, in milliseconds, that the server should wait for any operation to complete.

The wsb.create-server function is used to create a WSB server which can then be used to accept requests on the specified port, identify known valid requests and deliver them to the service applications for handling. wsb.create-server is used to set up the parameters necessary to manage the client services effectively.

You can use either the SOAP or XMLRPC protocol, or you can use a protocol of your own design, as long has that protocol uses an HTTP header to specify which action to perform. The type of protocol to be used is specified by the type attribute. The value of the type parameter affects the service-name and type parameters meaning for the wsb.add-service, wsb.remove-service and wsb.service-exists functions as follows:

• soap-service: service-name is the value of the SOAPAction HTTP header in the incoming request; type is always 'soapaction' or unspecified. For example, a request containing the HTTP header 'SOAPAction: myrpcfunc' will match a service-name of 'myrpcfunc'
• xmlrpc-service: service-name is the target of the POST request; type is always 'xmlrpc' or unspecified. For example, a request beginning with 'POST /myrpcfunc HTTP/1.0' will match a service-name of '/myrpcfunc'
• other-service: type and service-name are the name and value of a HTTP header. For example, a request containing the HTTP header 'OmniWebServices: myservicefunc' will match a service-name of 'myservicefunc' and a type of 'OmniWebServices'

You can specify a timeout value in milliseconds. The timeout value exists to ensure that an error on a connection does not tie up the server. The default value is 2500 milliseconds. A exception will be thrown if the specified time expires before an operation on the connection (read or write) completes.

Related Syntax    wsb.add-service    wsb.remove-service    wsb.service-exists

Other Library Functions    wsb.add-service    wsb.clear-all-services    wsb.create-server    wsb.dispatch-request    wsb.has-known-request-type    wsb.reader    wsb.remove-service    wsb.request    wsb.request-header    wsb.request-name    wsb.request-type    wsb.server    wsb.service-exists    wsb.start-servicing-requests    wsb.wait-for-request    wsb.writer

[ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACYLIBRARIES ] [ ERRORS ]