Sockread - Revision history

Vliedel at 18:26, 30 January 2011

2011-01-30T18:26:01Z

← Older revision		Revision as of 18:26, 30 January 2011
Line 34:		Line 34:

	[[Category:Socket]]		[[Category:Socket]]
			[[Category:Commands]]

Cail at 08:14, 2 July 2007

2007-07-02T08:14:46Z

← Older revision		Revision as of 08:14, 2 July 2007
Line 30:		Line 30:
	}		}

	=== See also ===		== See also ==
	* [[on sockread]]		* [[on sockread]]

	[[Category:Socket]]		[[Category:Socket]]

Vliedel at 18:48, 8 May 2007

2007-05-08T18:48:10Z

← Older revision		Revision as of 18:48, 8 May 2007
Line 5:		Line 5:
	If you specify a %var variable, a line of text ending with a Carriage Return/LineFeed is read into %var. The $crlf are stripped off (this may result in %var being $null if the line only consisted of $crlf).		If you specify a %var variable, a line of text ending with a Carriage Return/LineFeed is read into %var. The $crlf are stripped off (this may result in %var being $null if the line only consisted of $crlf).

	If you specify a ~~&binvar then [numbytes] of info is read into~~ the ~~binary~~ variable~~. If no [numbytes]~~ is ~~specified~~ it ~~defaults to 4096 bytes~~.		If you specify the -f switch with a %var variable, this forces mIRC to fill the %var variable with whatever text is in the receive buffer, even if it doesn't end in a $crlf.

	If you specify the ~~-f switch with a %var~~ variable~~, this forces mIRC~~ to ~~fill the %var variable~~ with ~~whatever text is in~~ the ~~receive buffer, even if it doesn't end in a $crlf~~.		If you specify a &binvar then [numbytes] of info is read into the binary variable. If no [numbytes] is specified it defaults to 4096 bytes. The &binvar is unset before filling it with the read data.

	The -n switch allows you to read a $crlf terminated line into a &binvar. If the incoming line does not contain a $crlf, no bytes will be read into &binvar, unless you specify the -f switch, which forces the read (same as when reading into %vars).		The -n switch allows you to read a $crlf terminated line into a &binvar. If the incoming line does not contain a $crlf, no bytes will be read into &binvar, unless you specify the -f switch, which forces the read (same as when reading into %vars).
Line 16:		Line 16:

	Example:		Example:
	This example shows you how you should process a sockread event. The socket has already been opened and has received information, so the sockread event is triggered. The socket name is testing~~. There is an explanation of each step below the sample script~~.		This example shows you how you should process a sockread event. The socket has already been opened and has received information, so the sockread event is triggered. The socket name is testing.

	on 1:sockread:testing:{		on 1:sockread:testing:{
	;when a sockerror occured, return		;when a sockerror occured, return
	if ($sockerr > 0) return		if ($sockerr > 0) return
			;start the loop to be able to sockread multiple times
	while (1) {		while (1) {
	sockread %temp		sockread %temp

Vliedel: changed example

2007-05-08T18:44:33Z

changed example

← Older revision		Revision as of 18:44, 8 May 2007
Line 19:		Line 19:

	on 1:sockread:testing:{		on 1:sockread:testing:{
	if ($sockerr > 0) return		;when a sockerror occured, return
	~~:nextread~~		if ($sockerr > 0) return
	sockread %temp		while (1) {
	if ($sockbr == 0) return		sockread %temp
	~~if (%temp == $null) %temp =~~ -		;when nothing is read, the buffer was empty, so we return
	~~echo 4~~ %temp		if ($sockbr == 0) return
	~~goto nextread~~		echo -ag sockread: %temp
			}
	}		}

Cail at 10:07, 11 September 2006

2006-09-11T10:07:08Z

← Older revision		Revision as of 10:07, 11 September 2006
Line 29:		Line 29:

	=== See also ===		=== See also ===
	* [[on ~~sockopen~~]]		* [[on sockread]]

	[[Category:Socket]]		[[Category:Socket]]

Cail at 10:06, 11 September 2006

2006-09-11T10:06:52Z

← Older revision		Revision as of 10:06, 11 September 2006
Line 28:		Line 28:
	}		}

			=== See also ===
			* [[on sockopen]]

	[[Category:Socket]]		[[Category:Socket]]

Cail at 09:55, 11 September 2006

2006-09-11T09:55:17Z

← Older revision		Revision as of 09:55, 11 September 2006
Line 1:		Line 1:
	/sockread [-fn] [numbytes] <%var\|&binvar>		'''/sockread [-fn] [numbytes] <%var\|&binvar>'''

	The /sockread command reads bytes from the receive buffer into the specified variable.		The /sockread command reads bytes from the receive buffer into the specified variable.

Cail at 09:53, 11 September 2006

2006-09-11T09:53:39Z

New page

/sockread [-fn] [numbytes] <%var|&binvar>
The /sockread command reads bytes from the receive buffer into the specified variable.

If you specify a %var variable, a line of text ending with a Carriage Return/LineFeed is read into %var. The $crlf are stripped off (this may result in %var being $null if the line only consisted of $crlf).

If you specify a &binvar then [numbytes] of info is read into the binary variable. If no [numbytes] is specified it defaults to 4096 bytes.

If you specify the -f switch with a %var variable, this forces mIRC to fill the %var variable with whatever text is in the receive buffer, even if it doesn't end in a $crlf.

The -n switch allows you to read a $crlf terminated line into a &binvar. If the incoming line does not contain a $crlf, no bytes will be read into &binvar, unless you specify the -f switch, which forces the read (same as when reading into %vars).

Note: A single /sockread may not be enough to read the entire buffer. You should keep reading until $sockbr (bytes read) is set to zero. This is far faster than letting mIRC re-trigger the event. If your script doesn't read the whole buffer, the on sockread event is re-triggered if:
a) you were reading into a &binvar.
b) you were reading into a %var and there is still a $crlf terminated line in the buffer waiting to be read.

Example:
This example shows you how you should process a sockread event. The socket has already been opened and has received information, so the sockread event is triggered. The socket name is testing. There is an explanation of each step below the sample script.

on 1:sockread:testing:{
if ($sockerr > 0) return
:nextread
sockread %temp
if ($sockbr == 0) return
if (%temp == $null) %temp = -
echo 4 %temp
goto nextread
}

[[Category:Socket]]