HttpWrite - Revision history

Sebassje at 10:27, 14 July 2009

2009-07-14T10:27:34Z

← Older revision		Revision as of 10:27, 14 July 2009
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool httpWrite ( string data, [int length] )		bool httpWrite ( string data [, int length] )
	</syntaxhighlight>		</syntaxhighlight>

EAi at 21:21, 24 December 2007

2007-12-24T21:21:39Z

← Older revision		Revision as of 21:21, 24 December 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{HTTP function}}		{{HTTP function}}
	This function adds text to the output of the current HTTP file of the [[Resource_Web_Access\|HTTP interface]]. The function can only be used on parsed (i.e not marked as ''raw'') HTTP pages.		This function adds text to the output of the current HTTP file of the [[Resource_Web_Access\|HTTP interface]]. The function can only be used on parsed (i.e not marked as ''raw'') HTTP pages. httpWrite can support outputing binary data, if you specify the length of the data you are outtputing. If you do this, you should ensure you set an accurate content-type using [[httpSetResponseHeader]] otherwise it may be displayed inconsistently by browsers.

	==Syntax==		==Syntax==
Line 19:		Line 19:

	===Required Arguments===		===Required Arguments===
	*'''data:''' the ~~string of text~~ to be added to the page's output.		*'''data:''' the data to be added to the page's output.

	===Optional Arguments===		===Optional Arguments===

EAi at 21:18, 24 December 2007

2007-12-24T21:18:38Z

← Older revision		Revision as of 21:18, 24 December 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{HTTP function}}		{{HTTP function}}
	This function adds text to the output of the current ~~HTML~~ file of the [[Resource_Web_Access\|HTTP interface]].		This function adds text to the output of the current HTTP file of the [[Resource_Web_Access\|HTTP interface]]. The function can only be used on parsed (i.e not marked as ''raw'') HTTP pages.

	==Syntax==		==Syntax==

EAi: /* Example */

2007-12-22T19:52:26Z

Example

← Older revision		Revision as of 19:52, 22 December 2007
Line 28:		Line 28:

	==Example==		==Example==
	This sample resource page will output a random quote from a player using a function previously exported to http from a Lua script in the resource.		'''Example 1:''' This sample resource page will output a random quote from a player using a function previously exported to http from a Lua script in the resource.
	<syntaxhighlight lang="lua">[html]		<syntaxhighlight lang="lua">[html]
	<html>		<html>

EAi at 19:52, 22 December 2007

2007-12-22T19:52:10Z

← Older revision		Revision as of 19:52, 22 December 2007
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool httpWrite ( string ~~text~~ )		bool httpWrite ( string data, [int length] )
	</syntaxhighlight>		</syntaxhighlight>

Line 19:		Line 19:

	===Required Arguments===		===Required Arguments===
	*'''~~text~~:''' the string of text to be added to the page's output.		*'''data:''' the string of text to be added to the page's output.

			===Optional Arguments===
			*'''length:''' The length of the data being written. Generally only should be required for writing binary data.

	===Returns===		===Returns===
Line 39:		Line 42:

	The second httpWrite call writes the quote generated by the function to the HTML output.		The second httpWrite call writes the quote generated by the function to the HTML output.

			'''Example 2:''' Using httpWrite to return a file read in with [[fileRead]]. This is useful as the internal server doesn't not support subdirectories reliably so you can create a page to return files to you.
			<syntaxhighlight lang="lua">
			<*
			local file = fileOpen ( "icons/icon.png" )
			if file then
			while not fileIsEOF(file) do
			buffer = fileRead(file, 500)
			httpWrite(buffer, buffer:len())
			end
			fileClose(file)
			httpSetResponseHeader ( "content-type", "image/png")
			else
			*>
			Could not read file
			<*
			end
			*>
			</syntaxhighlight>

	==See Also==		==See Also==
	{{HTTP functions}}		{{HTTP functions}}

EAi: /* Shortcut syntax */

2007-11-01T11:50:43Z

Shortcut syntax

← Older revision		Revision as of 11:50, 1 November 2007
Line 9:		Line 9:

	===Shortcut syntax===		===Shortcut syntax===
	The following shortcut syntax is also supported:		The following shortcut syntax is also supported (the space between the ''<*'' and the ''='' is optional):
	<syntaxhighlight lang="lua">[html]		<syntaxhighlight lang="lua">[html]
	<* = text *>		<* = text *>

Jbeta: Reverted again: disregard last edit - it's not js

2007-10-27T15:52:10Z

Reverted again: disregard last edit - it's not js

← Older revision		Revision as of 15:52, 27 October 2007
Line 32:		Line 32:
	</head>		</head>
	<body>		<body>
	<b>Random quote:</b> <* httpWrite( getRandomQuote() ) *>		<b>Random quote:</b> <* httpWrite( call ( getThisResource(), "getRandomQuote" ) ) *>
	</body>		</body>
	</html>		</html>

Jbeta: Reverted: Direct call to JS getRandomQuote was not wrong. That's what the ajax resource is for.

2007-10-26T13:53:34Z

Reverted: Direct call to JS getRandomQuote was not wrong. That's what the ajax resource is for.

← Older revision		Revision as of 13:53, 26 October 2007
Line 32:		Line 32:
	</head>		</head>
	<body>		<body>
	<b>Random quote:</b> <* httpWrite( ~~call~~ ( ~~getThisResource(), "getRandomQuote"~~ ) ) *>		<b>Random quote:</b> <* httpWrite( getRandomQuote() ) *>
	</body>		</body>
	</html>		</html>

Lil Toady: /* Example */

2007-10-26T13:03:22Z

Example

← Older revision		Revision as of 13:03, 26 October 2007
Line 32:		Line 32:
	</head>		</head>
	<body>		<body>
	<b>Random quote:</b> <* httpWrite( getRandomQuote() ) *>		<b>Random quote:</b> <* httpWrite( call ( getThisResource(), "getRandomQuote" ) ) *>
	</body>		</body>
	</html>		</html>

Jbeta: Documented

2007-10-26T01:19:27Z

Documented

New page

__NOTOC__
{{HTTP function}}
This function adds text to the output of the current HTML file of the [[Resource_Web_Access|HTTP interface]].

==Syntax==
<syntaxhighlight lang="lua">
bool httpWrite ( string text )
</syntaxhighlight>

===Shortcut syntax===
The following shortcut syntax is also supported:
<syntaxhighlight lang="lua">[html]
<* = text *>
</syntaxhighlight>
which is equivalent to:
<syntaxhighlight lang="lua">[html]
<* httpWrite(text) *>
</syntaxhighlight>

===Required Arguments===
*'''text:''' the string of text to be added to the page's output.

===Returns===
Returns ''true'' if the text was added to the output buffer successfully, ''false'' otherwise.

==Example==
This sample resource page will output a random quote from a player using a function previously exported to http from a Lua script in the resource.
<syntaxhighlight lang="lua">[html]
<html>
<head>
<* = call ( getResourceFromName("ajax"), "start", getResourceName(getThisResource()) ) *>
</head>
<body>
<b>Random quote:</b> <* httpWrite( getRandomQuote() ) *>
</body>
</html>
</syntaxhighlight>
The first httpWrite call (in shortcut syntax) adds the links to scripts generated by the ajax resource, enabling use of the getRandomQuote function.

The second httpWrite call writes the quote generated by the function to the HTML output.

==See Also==
{{HTTP functions}}