.\" Man page generated from reStructuredText.
.
.TH "TSTEXTLOGOBJECTCREATE" "3ts" "Mar 08, 2019" "7.1" "Apache Traffic Server"
.SH NAME
TSTextLogObjectCreate \- traffic Server text logging API
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fI#include <ts/ts.h>\fP
.INDENT 0.0
.TP
.B TSReturnCode TSTextLogObjectCreate(const char *\fI\ filename\fP, int\fI\ mode\fP, TSTextLogObject *\fI\ new_log_obj\fP)
.UNINDENT
.INDENT 0.0
.TP
.B TSReturnCode TSTextLogObjectWrite(TSTextLogObject\fI\ the_object\fP, const char *\fI\ format\fP, \&...)
.UNINDENT
.INDENT 0.0
.TP
.B void TSTextLogObjectFlush(TSTextLogObject\fI\ the_object\fP)
.UNINDENT
.INDENT 0.0
.TP
.B TSReturnCode TSTextLogObjectDestroy(TSTextLogObject\fI\ the_object\fP)
.UNINDENT
.INDENT 0.0
.TP
.B void TSTextLogObjectHeaderSet(TSTextLogObject\fI\ the_object\fP, const char *\fI\ header\fP)
.UNINDENT
.INDENT 0.0
.TP
.B TSReturnCode TSTextLogObjectRollingEnabledSet(TSTextLogObject\fI\ the_object\fP, int\fI\ rolling_enabled\fP)
.UNINDENT
.INDENT 0.0
.TP
.B void TSTextLogObjectRollingIntervalSecSet(TSTextLogObject\fI\ the_object\fP, int\fI\ rolling_interval_sec\fP)
.UNINDENT
.INDENT 0.0
.TP
.B void TSTextLogObjectRollingOffsetHrSet(TSTextLogObject\fI\ the_object\fP, int\fI\ rolling_offset_hr\fP)
.UNINDENT
.INDENT 0.0
.TP
.B void TSTextLogObjectRollingSizeMbSet(TSTextLogObject\fI\ the_object\fP, int\fI\ rolling_size_mb\fP)
.UNINDENT
.SH DESCRIPTION
.sp
\fI\%TSTextLogObjectRollingEnabledSet()\fP sets the log rolling mode
for the given object. This API must be used once the object is
created and before writing into logs. The \fIrolling_enabled\fP
argument must be a valid \fBproxy.config.log.rolling_enabled\fP
values. If \fI\%TSTextLogObjectRollingEnabledSet()\fP is never called,
the log object takes it\(aqs log rolling mode from the global
\fBproxy.config.log.rolling_enabled\fP setting.
.sp
It\(aqs also important to call \fI\%TSTextLogObjectRollingEnabledSet()\fP before
any of the other APIs that modifies the rolling object. This is due to the
fact that this API dictates which rolling mode should be used, and therefore
affects further modifications of the logging object.
.SH SEE ALSO
.sp
\fBTSAPI(3ts)\fP
.SH COPYRIGHT
2019, dev@trafficserver.apache.org
.\" Generated by docutils manpage writer.
.