tfHttpdUserRegisterRequestHeader

Table of Contents >> Application Reference >> Web Server

#include <trsocket.h>

int tfHttpdUserRegisterRequestHeader	(
	ttHttpdUserSrvHandle userSrvHandle,
	ttHttpUserHeaderType headerType
	);

Function Description

Tell the web server to save the specified type of HTTP header so that it will be saved on the user connection structure. This API should be called after the server is started.

Parameters

• userSrvHandle

  HTTP user server handle returned from tfHttpdUserStart().

• headerType

  Header type to be registered, one of the following (from ttHttpUserHeaderType in trsocket.h):

  TM_HTTP_HEADER_ALLOW

  TM_HTTP_HEADER_AUTH_INFO

  TM_HTTP_HEADER_AUTHORIZATION

  TM_HTTP_HEADER_CONNECTION

  TM_HTTP_HEADER_CONTENT_ENCODING

  TM_HTTP_HEADER_CONTENT_LENGTH

  TM_HTTP_HEADER_CONTENT_RANGE

  TM_HTTP_HEADER_CONTENT_TYPE

  TM_HTTP_HEADER_COOKIE

  TM_HTTP_HEADER_COOKIE2

  TM_HTTP_HEADER_DATE

  TM_HTTP_HEADER_EXPIRES

  TM_HTTP_HEADER_FROM

  TM_HTTP_HEADER_HOST

  TM_HTTP_HEADER_IF_MODIFIED_SINCE

  TM_HTTP_HEADER_LAST_MODIFIED

  TM_HTTP_HEADER_LOCATION

  TM_HTTP_HEADER_PRAGMA

  TM_HTTP_HEADER_RANGE

  TM_HTTP_HEADER_REFERER

  TM_HTTP_HEADER_SERVER

  TM_HTTP_HEADER_SET_COOKIE

  TM_HTTP_HEADER_TRANSFER_ENCODING

  TM_HTTP_HEADER_USER_AGENT

  TM_HTTP_HEADER_WWW_AUTHENTICATE

  TM_HTTP_HEADER_RETRY_AFTER

  TM_HTTP_HEADER_IF_NONE_MATCH

  TM_HTTP_HEADER_ETAG

  TM_HTTP_HEADER_IF_MATCH

  TM_HTTP_HEADER_X_FRAME_OPTIONS

  TM_HTTP_HEADER_X_XSS_PROTECTION

  TM_HTTP_HEADER_X_CONTENT_TYPE_OPTIONS

  TM_HTTP_HEADER_STRICT_TRANSPORT_SECURITY

  If TM_USE_SOAP is enabled, the following header type is also supported:

  TM_HTTP_HEADER_EXT

  TM_HTTP_HEADER_MAN

  TM_HTTP_HEADER_SOAPACTION

  If TM_USE_GENA is enabled, the following header type is also supported:

  TM_HTTP_HEADER_SID

  TM_HTTP_HEADER_TIMEOUT

  TM_HTTP_HEADER_NT

  TM_HTTP_HEADER_NTS

  TM_HTTP_HEADER_SEQ

  TM_HTTP_HEADER_CALLBACK

  The following type is a special value meaning all headers:

  TM_HTTP_HEADER_ALL

Returns

• TM_ENOERROR

  Success

• TM_EINVAL

  Invalid parameter(s)

Table of Contents >> Application Reference >> Web Server