Technical Reference: Communications, Volume 2

FrcaCtrlLog Subroutine

Purpose

Modifies the behavior of the logging subsystem.

Library

FRCA Library (libfrca.a)

Syntax

#include <frca.h> int32_t FrcaCtrlLog ( FrcaHandle, Flags); int32_t FrcaHandle; uint32_t Flags;

Description

The FrcaCtrlLog subroutine modifies the behavior of the logging subsystem for the Fast Response Cache Accelerator (FRCA) instance specified. Modifiable attributes are the logging mode, which can be turned on or off, and the logging format, which defaults to the HTTP Common Log Format (CLF). The logging format can be changed to Extended Common Log Format (ECLF) and can be set to include virtual host information.

The only FRCA instance type that is currently supported handles static GET requests as part of the Hypertext Transfer Protocol (HTTP).

Parameters

FrcaHandle	Returns a handle that is required by the other FRCA API subroutines to refer to the newly configured FRCA instance.
Flags	Specifies the behavior of the logging subsystem. The parameter value is constructed by logically ORing single flags. The valid flags are as follows: FCTRL_LOGFORMAT FCTRL_LOGFORMAT_ECLF FCTRL_LOGFORMAT_VHOST FCTRL_LOGMODE FCTRL_LOGMODE_ON

Return Values

0	The subroutine completed successfully.
-1	The subroutine failed. The global variable errno is set to indicate the specific type of error.

Error Codes

ENOTREADY

The kernel extension is currently being loaded or unloaded.

Related Information

The FrcaCacheCreate subroutine, the FrcaCacheDelete subroutine, the FrcaCacheLoadFile subroutine, the FrcaCacheUnloadFile subroutine, the FrcaCtrlCreate subroutine, the FrcaCtrlDelete subroutine, the FrcaCtrlStart subroutine, the FrcaCtrlStop subroutine.