Modified: incubator/trafficserver/site/trunk/docs/sdk/INKfopenFamilyFunctions.html URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKfopenFamilyFunctions.html?rev=882316&r1=882315&r2=882316&view=diff ============================================================================== --- incubator/trafficserver/site/trunk/docs/sdk/INKfopenFamilyFunctions.html (original) +++ incubator/trafficserver/site/trunk/docs/sdk/INKfopenFamilyFunctions.html Thu Nov 19 21:58:27 2009 @@ -1,49 +1,49 @@ - + The INKfopen Family - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -51,7 +51,7 @@
Home -

Traffic Server Software Developers Kit

+

Traffic Server Software Developers Kit

The fopen family of functions in C is normally used for reading configuration files, since fgets - is an easy way to parse files on a line by line basis. The - INKfopen family of functions is aimed at solving - the same problem of buffered IO and line at a time IO in a platform - independent manner. The INKfopen family of - functions works exactly the same under Microsoft Windows NT as it does - under any of the Unix platforms Traffic Server runs on. Further, the + is an easy way to parse files on a line-by-line basis. The + INKfopen family of functions is intended to solve + the same problem of buffered IO and line at a time IO, in a platform-independent manner. The fopen family of C library functions can only open a - file if a file descriptor less than 256 is available. Traffic Server - often has more than 2000 file descriptors open at once, making the + file if a file descriptor less than 256 is available. Since Traffic Server + often has more than 2000 file descriptors open at once, however, the likelihood of an available file descriptor less than 256 very small. The INKfopen family can open files with descriptors greater than 256.

The INKfopen family of routines is not - intended for high speed IO or for flexibility. It is intended for + intended for high speed IO or flexibility. These routines are intended for reading and writing configuration information when corresponding usage - of the fopen family of functions is inappropriate because of file - descriptor and portability limitations. The - INKfopen family of functions consists of:

+ of the fopen family of functions is inappropriate because of file + descriptor and portability limitations. The INKfopen family of functions consists of the following:

INKfclose

Closes a file.

-
Prototype
+
Prototype

void INKfclose (INKFile filep)

-
Arguments
-

filep is the file +

Arguments
+
+

filep is the file to close.

-
Description
-

Closes the file pointed to by - filep and frees the data - structures and buffers associated with it. If the file was - opened for writing, any pending data is flushed.

-
Example
-

See the example for INKfopen.

-
First release
-

Traffic Server 3.0

+
Description
+
+

Closes the file pointed to by + filep and frees the data + structures & buffers associated with it. If the file was + opened for writing, then any pending data is flushed.

+
Example
+

See the example for INKfopen

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKfread.html URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKfread.html?rev=882316&r1=882315&r2=882316&view=diff ============================================================================== --- incubator/trafficserver/site/trunk/docs/sdk/INKfread.html (original) +++ incubator/trafficserver/site/trunk/docs/sdk/INKfread.html Thu Nov 19 21:58:27 2009 @@ -1,43 +1,43 @@ - + INKfread - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -45,7 +45,7 @@
Home -

Traffic Server Software Developers Kit

+

Traffic Server Software Developers Kit

Writes a specified number of bytes to a file.

-
Prototype
-

int INKfwrite (INKFile filep, void *buf, int - length)

-
Arguments
+
Prototype
+

int INKfwrite (INKFile filep, void *buf, int + length)

+
Arguments
-

filep is the file +

filep is the file to write to.

-

buf is the buffer - containing the data to be written.

-

length is the +

buf is the buffer + that contains the data to be written.

+

length is the amount of data to write to filep.

-
Description
-

Attempts to write - length bytes of data to +

Description
+
+

Attempts to write + length bytes of data to the file pointed to by - filep from the buffer + filep from the buffer buf. If the file was not - opened for writing, INKfwrite returns -1. + opened for writing, then INKfwrite returns -1. Otherwise, INKfwrite returns the number of bytes written. Unless an error occurs when writing data to the file, the number of bytes written is equal to length. One common error is an insufficient amount of space on disk.

-
First release
-

Traffic Server 3.0

Modified: incubator/trafficserver/site/trunk/docs/sdk/IOBufferInterfaceFunctions.html URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/IOBufferInterfaceFunctions.html?rev=882316&r1=882315&r2=882316&view=diff ============================================================================== --- incubator/trafficserver/site/trunk/docs/sdk/IOBufferInterfaceFunctions.html (original) +++ incubator/trafficserver/site/trunk/docs/sdk/IOBufferInterfaceFunctions.html Thu Nov 19 21:58:27 2009 @@ -1,63 +1,63 @@ - + IO Buffer Interface - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -65,7 +65,7 @@
Home -

Traffic Server Software Developers Kit

+

Traffic Server Software Developers Kit

Gets next IO buffer block.

-
Prototype
+
Prototype

INKIOBufferBlock INKIOBufferBlockNext (INKIOBufferBlock blockp)

-
Description
+
Description

Gets the next block in the buffer block chain.

-
Returns
+
Returns

The next IO buffer block.

INK_ERROR_PTR if an error occurs.

-
First release
-

Traffic Server 3.0

Modified: incubator/trafficserver/site/trunk/docs/sdk/ImplementHandler_GetTransHandle.html URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/ImplementHandler_GetTransHandle.html?rev=882316&r1=882315&r2=882316&view=diff ============================================================================== --- incubator/trafficserver/site/trunk/docs/sdk/ImplementHandler_GetTransHandle.html (original) +++ incubator/trafficserver/site/trunk/docs/sdk/ImplementHandler_GetTransHandle.html Thu Nov 19 21:58:27 2009 @@ -1,44 +1,44 @@ - + Implementing the Handler and Getting a Handle to the Transaction - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -46,7 +46,7 @@
Home -

Traffic Server Software Developers Kit

+

Traffic Server Software Developers Kit

Modified: incubator/trafficserver/site/trunk/docs/sdk/InitiateHTTPConnection.html URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/InitiateHTTPConnection.html?rev=882316&r1=882315&r2=882316&view=diff ============================================================================== --- incubator/trafficserver/site/trunk/docs/sdk/InitiateHTTPConnection.html (original) +++ incubator/trafficserver/site/trunk/docs/sdk/InitiateHTTPConnection.html Thu Nov 19 21:58:27 2009 @@ -1,43 +1,43 @@ - + Initiate HTTP Connection - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -45,7 +45,7 @@
Home -

Traffic Server Software Developers Kit

+

Traffic Server Software Developers Kit