SFSArray Class |
The SFSArray class is used by SmartFoxServer in client-server data transfer.
Inheritance HierarchySystemObject
Sfs2X.Entities.DataSFSArray
Sfs2X.Entities.DataSFSArray
Namespace: Sfs2X.Entities.Data
Assembly: SmartFox2X (in SmartFox2X.dll) Version: 1.8.0.0 (1.8.0)
SyntaxC#
public class SFSArray : ISFSArray, ICollection, IEnumerable
The SFSArray type exposes the following members.
ConstructorsMethods| Name | Description | |
|---|---|---|
 | AddBool |
Appends a boolean value to the end of this array.
|
| AddBoolArray |
Appends an array of boolean values to the end of this array.
|
| AddByte |
Appends a byte (8 bits) value to the end of this array.
|
| AddByteArray |
Appends a ByteArray object to the end of this array.
|
| AddClass |
Appends the passed custom class instance to the end of this array.
|
| AddDouble |
Appends a double precision number (64 bits) value to the end of this array.
|
| AddDoubleArray |
Appends an array of double precision number values to the end of this array.
|
| AddFloat |
Appends a floating point number (32 bits) value to the end of this array.
|
| AddFloatArray |
Appends an array of floating point number values to the end of this array.
|
| AddInt |
Appends an integer (32 bits) value to the end of this array.
|
| AddIntArray |
Appends an array of integer values to the end of this array.
|
| AddLong |
Appends a long integer (64 bits) value to the end of this array.
|
| AddLongArray |
Appends an array of long integer values to the end of this array.
|
| AddNull |
Appends a null value to the end of this array.
|
| AddSFSArray |
Appends an ISFSArray object to the end of this array.
|
| AddSFSObject |
Appends a ISFSObject object to the end of this array.
|
| AddShort |
Appends a short integer (16 bits) value to the end of this array.
|
| AddShortArray |
Appends an array of short integer values to the end of this array.
|
| AddText |
Appends a UTF-8 string (with max length of 2 GBytes) value to the end of this array.
|
| AddUtfString |
Appends a UTF-8 string (with max length of 32 KBytes) value to the end of this array.
|
| AddUtfStringArray |
Appends an array of UTF-8 string values to the end of this array.
|
| Contains |
Indicates whether this array contains the specified object or not.
|
| GetBool |
Returns the element at the specified position as a boolean.
|
| GetBoolArray |
Returns the element at the specified position as an array of booleans.
|
| GetByte |
Returns the element at the specified position as a signed byte (8 bits).
|
| GetByteArray |
Returns the element at the specified position as a ByteArray object.
|
 | GetClass |
Returns the element at the specified position as an instance of a custom class.
|
| GetDouble |
Returns the element at the specified position as a double precision number.
|
| GetDoubleArray |
Returns the element at the specified position as an array of doubles.
|
| GetDump |
See GetDump(Boolean).
|
| GetDump(Boolean) |
Provides a formatted string representing this array.
|
| GetElementAt |
Returns the element at the specified position in this array.
|
| GetFloat |
Returns the element at the specified position as a floating point number.
|
| GetFloatArray |
Returns the element at the specified position as an array of floats.
|
| GetHexDump |
Provides a detailed hexadecimal representation of this array.
|
| GetInt |
Returns the element at the specified position as an integer (32 bits).
|
| GetIntArray |
Returns the element at the specified position as an array of integers.
|
| GetLong |
Returns the element at the specified position as a long integer (64 bits).
|
| GetLongArray |
Returns the element at the specified position as an array of longs.
|
| GetSFSArray |
Returns the element at the specified position as an ISFSArray object.
|
| GetSFSObject |
Returns the element at the specified position as an ISFSObject object.
|
| GetShort |
Returns the element at the specified position as a short integer (16 bits).
|
| GetShortArray |
Returns the element at the specified position as an array of shorts.
|
| GetText |
Returns the element at the specified position as an UTF-8 string, with max length of 2 GBytes.
|
| GetUtfString |
Returns the element at the specified position as an UTF-8 string, with max length of 32 KBytes.
|
| GetUtfStringArray |
Returns the element at the specified position as an array of UTF-8 strings.
|
| IsNull |
Indicates if the element at the specified position in this array is null.
|
 | NewFromBinaryData |
Returns a new SFSArray instance.
|
| NewFromJsonData |
Returns a new ISFSArray instance.
|
| NewInstance |
Returns a new SFSArray instance.
|
| RemoveElementAt |
Removes the element at the specified position in this array.
|
| Size |
Indicates the number of elements in this array.
|
| ToBinary |
Provides the binary form of this array.
|
| ToJson |
Provides the JSON representation of this array.
|
Remarks
This class can be thought of as a specialized Array/List object that can contain any type of data.
The advantage of using the SFSArray class (for example as a nested object inside a SFSObject object) is that you can fine tune the way your data is transmitted over the network.
For instance, when transmitting a list of numbers between 0 and 100, those values can be treated as normal integers (which take 32 bits each), but also as shorts (16 bit) or even as bytes (8 bit).
SFSArray supports many primitive data types and related arrays of primitives (see the SFSDataType class). It also allows to serialize class instances and rebuild them on the other side (client or server).
Check the SmartFoxServer 2X documentation for more informations on this advanced topic.
See Also