Core Function SSRead - Revision history

UberFoX at 06:22, 15 June 2015

2015-06-15T06:22:27Z

← Older revision		Revision as of 06:22, 15 June 2015
Line 1:		Line 1:
	<pre>		<pre>
−	SSRead( <~~message buffer~~>, <data type> )	+	SSRead( <client/server>, <data type> )
	</pre>		</pre>

	=== Description ===		=== Description ===

−	Read data from a ~~message~~.	+	Read data from a client/server.

	=== Parameters ===		=== Parameters ===

−	==== <~~message buffer~~> ====	+	==== <client/server> ====

−	The ~~message buffer~~ to read from.	+	The client or server object to read data from.

	==== <data-type> ====		==== <data-type> ====
Line 38:		Line 38:
	Success: Returns the data as requested.		Success: Returns the data as requested.

−	Failure: Returns 0.	+	Failure: Returns null.

	=== Remarks ===		=== Remarks ===

UberFoX: 3 revisions

2015-06-14T12:38:52Z

3 revisions

← Older revision

Revision as of 12:38, 14 June 2015

UberFoX: /* */

2015-06-13T05:18:24Z

← Older revision		Revision as of 05:18, 13 June 2015
Line 19:		Line 19:
	<pre>		<pre>
	[CODE] [TYPE]		[CODE] [TYPE]
−	"v" Binary (~~Array of~~ bytes) ~~// This returns a binary variable~~)	+	"v" Binary (Reads an Int32 for size then reads that many bytes)
−	"b" Byte	+	"V" Binary (Reads from current positoin to end of the buffer)
		+	"b" Byte (signed)
		+	"B" Byte (unsigned)
	"s" Int16		"s" Int16
	"i" Int32		"i" Int32

UberFoX: /* */

2015-06-13T05:15:24Z

← Older revision		Revision as of 05:15, 13 June 2015
Line 13:		Line 13:
	The message buffer to read from.		The message buffer to read from.

−	==== <data type> ====	+	==== <data-type> ====

	The type of data to read from the message buffer valid options are:		The type of data to read from the message buffer valid options are:

UberFoX: 1 revision

2014-08-11T21:40:41Z

1 revision

← Older revision

Revision as of 21:40, 11 August 2014

UberFoX: Created page with "

 SSRead( ,  )

=== Description === Read data from a message. === Parameters === ==== ==== The message buffer to read f..."

2011-12-01T12:35:22Z

Created page with "<pre> SSRead( <message buffer>, <data type> ) </pre> === Description === Read data from a message. === Parameters === ==== <message buffer> ==== The message buffer to read f..."

New page

<pre>
SSRead( <message buffer>, <data type> )
</pre>

=== Description ===

Read data from a message.

=== Parameters ===

==== <message buffer> ====

The message buffer to read from.

==== <data type> ====

The type of data to read from the message buffer valid options are:

<pre>
[CODE] [TYPE]
"v" Binary (Array of bytes) // This returns a binary variable)
"b" Byte
"s" Int16
"i" Int32
"l" Int64
"S" UInt16
"I" UInt32
"L" UInt64
"f" Float
"d" Double
"p" String
</pre>

=== Return Value ===

Success: Returns the data as requested.

Failure: Returns 0.

=== Remarks ===

This is NOT a generic socket toolset; You can't use this to connect to anything instead it is used to connect Sputnik clients with Sputnik servers in a very easy to use way.

=== Example ===

See the Listen() and Connect() for examples

[[Category:Core Function]]