Loading TOC...

admin.appserverSetRequestTimeout

admin.appserverSetRequestTimeout(
   $config as element(configuration),
   $appserver-id as String,
   $value as Number
) as element(configuration)

Summary

This function sets the value of the socket request timeout (the number of seconds before the socket times out) in the configuration for the specified App Server.

Parameters
$config A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id The ID of the App Server. Typically, this is the result of an admin:appserver-get-id call.
$value An integer specifying the number of seconds before a socket request times out.

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/admin/app-server

http://marklogic.com/xdmp/privileges/admin/app-server/{id}

http://marklogic.com/xdmp/privileges/admin/group

http://marklogic.com/xdmp/privileges/admin/group/{id}

Example


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
		  at "/MarkLogic/admin.xqy";

  let $config := admin:get-configuration()
  let $groupid := admin:group-get-id($config, "Default")
  return
  admin:appserver-set-request-timeout($config,
         admin:appserver-get-id($config, $groupid, "myAppServer"),
         10)

  (: returns the new configuration element -- use admin:save-configuration
     to save the changes to the configuration or pass the configuration
     to other Admin API functions to make other changes.  :)

  

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.