Previous Topic
Table Of Contents
Parent Topic
Next Topic

SWSSET Function

Related Topics

Web Server API Function Index

gfChkMrk.gif (134 bytes) May be used in Shadow/REXX. See RETURN RESCAN or RETURN FLUSH.
gfChkMrk.gif (134 bytes) May be used from Other REXX Interpreters.
gfChkMrk.gif (134 bytes) High-level language interface available.

The SWSSET built-in function allows the caller to control various run-time environmental options. Following is a list of functions that may be specified:

Function Name Description Sub-parameter
RESCAN This function provides a new URL value which the Server will use during the rescan operation. The rescan operation does not actually begin until after the current application program terminates normally. Specify a 1-to-128 byte URL rescan value.
FLUSH This function forces any scheduled output to be sent to the user and terminates any further processing. This function has no sub-parameters.
NOFLUSH This function reverses the effects of a prior flush request. This must be executed as part of the same rule section in order to reverse the effect of any prior FLUSH request. This function has no sub-parameters.
SENDTRACE This function allows the user to specify the output tracing option. YES to turn the option on.
NO to turn the option off.
PARSETRACE This function allows the user to specify the URL tracing option. YES to turn the option on.
NO to turn the option off.
RESPMODE This function allows the user to specify the server parsing mode. NONE for Non-parsed headers.
SERVER for Server-parsed headers.
DPRTY This function allows the user to adjust the current processing priority of their TCB within the Shadow Server address space. This may be a positive or negative whole number which will be added to the TCB's current dispatching priority. A value from -255 to 255.
AUTOFLUSH This function allows the user to specify the maximum number of buffers to allow before automatically sending them. A value from 0 to 32767.
MAXRESPBYTES This function allows the user to specify the maximum number of bytes that can be sent in response to a single URL. A value from 0 to 2147483647.
MAXRESPBUFFERS This function allows the user to specify the maximum number of buffers that can be sent in response to a single URL. A value from 0 to 32767.
USERDATA1 This function allows the user to specify a text sting to be inserted in the Shadow OS/390 Web Server SMF record. Must be a text string from 1 to 256 bytes long.
USERDATA2 This function allows the user to specify a text sting to be inserted in the Shadow OS/390 Web Server SMF record. This string of text is secured in as much as it may only be specified in a WWW Master rule. Must be a text string from 1 to 256 bytes long.
ASCIIEBCDICMAPPING This function allows the user to specify the language code for ASCII-to-EBCDIC character translation Must be one of the known values

Top

gfGrayBr.gif (1830 bytes)

Return Values

SWSSET always sets a signed numeric return code value. Possible values are:

RC = 0
The operation succeeded.
 
RC = -1
The API call cannot "connect back" into the subsystem code properly.

Coding Samples 

rc = SWSSET( 'RESCAN', newurl ) 
 
rc = SWSSET( 'FLUSH' ) 
 
rc = SWSSET( 'NOFLUSH' ) 
 
rc = SWSSET( 'SENDTRACE', 'YES' ) 
 
rc = SWSSET( 'PARSETRACE', 'YES' ) 
 
rc = SWSSET( 'RESPMODE', 'SERVER' ) 
 
rc = SWSSET( 'DPRTY', '-2' ) 
 
rc = SWSSET( 'AUTOFLUSH', '25' ) 
 
rc = SWSSET( 'MAXRESPBYTES', '10000' ) 
 
rc = SWSSET( 'MAXRESPBUFFERS' '100' ) 
 
rc = SWSSET( 'USERDATA1' 'USER MESSAGE DATA' ) 
 
rc = SWSSET( 'USERDATA2' 'SECURED USER MESSAGE DATA' ) 
 
rc = SWSSET( 'ASCIIEBCDICMAPPING' 'FRA2' )

Top