SFSObject Class |
The SFSObject class is used by SmartFoxServer in client-server data transfer.
Inheritance HierarchySystemObject
Sfs2X.Entities.DataSFSObject
Sfs2X.Entities.DataSFSObject
Namespace: Sfs2X.Entities.Data
Assembly: SmartFox2X (in SmartFox2X.dll) Version: 1.8.0.0 (1.8.0)
SyntaxC#
public class SFSObject : ISFSObject
The SFSObject type exposes the following members.
ConstructorsMethods| Name | Description | |
|---|---|---|
 | ContainsKey |
Indicates whether this object contains a mapping for the specified key or not.
|
| GetBool |
Returns the element corresponding to the specified key as a boolean.
|
| GetBoolArray |
Returns the element corresponding to the specified key as an array of booleans.
|
| GetByte |
Returns the element corresponding to the specified key as a signed byte (8 bits).
|
| GetByteArray |
Returns the element corresponding to the specified key as a ByteArray object.
|
 | GetClass |
Returns the element corresponding to the specified key as an instance of a custom class.
|
| GetDouble |
Returns the element corresponding to the specified key as a double precision number.
|
| GetDoubleArray |
Returns the element corresponding to the specified key as an array of doubles.
|
| GetDump |
See GetDump(Boolean).
|
| GetDump(Boolean) |
Provides a formatted string representing this object.
|
| GetFloat |
Returns the element corresponding to the specified key as a floating point number.
|
| GetFloatArray |
Returns the element corresponding to the specified key as an array of floats.
|
| GetHexDump |
Provides a detailed hexadecimal representation of this object.
|
| GetInt |
Returns the element corresponding to the specified key as an integer (32 bits).
|
| GetIntArray |
Returns the element corresponding to the specified key as an array of integers.
|
| GetKeys |
Retrieves a list of all the keys contained in this object.
|
| GetLong |
Returns the element corresponding to the specified key as a long integer (64 bits).
|
| GetLongArray |
Returns the element corresponding to the specified key as an array of longs.
|
| GetSFSArray |
Returns the element corresponding to the specified key as an ISFSArray object.
|
| GetSFSObject |
Returns the element corresponding to the specified key as an ISFSObject object.
|
| GetShort |
Returns the element corresponding to the specified key as a short integer (16 bits).
|
| GetShortArray |
Returns the element corresponding to the specified key as an array of shorts.
|
| GetText |
Returns the element corresponding to the specified key as an UTF-8 string, with max length of 2 GBytes.
|
| GetUtfString |
Returns the element corresponding to the specified key as an UTF-8 string, with max length of 32 KBytes.
|
| GetUtfStringArray |
Returns the element corresponding to the specified key as an array of UTF-8 strings.
|
| IsNull |
Indicates if the value mapped by the specified key is null.
|
 | NewFromBinaryData |
Returns a new SFSObject instance.
|
| NewFromJsonData |
Returns a new ISFSObject instance.
|
| NewInstance |
Returns a new SFSObject instance.
|
| PutBool |
Associates the passed boolean value with the specified key in this object.
|
| PutBoolArray |
Associates the passed array of booleans with the specified key in this object.
|
| PutByte |
Associates the passed byte value with the specified key in this object.
|
| PutByteArray |
Associates the passed ByteArray object with the specified key in this object.
|
| PutClass |
Associates the passed custom class instance with the specified key in this object.
|
| PutDouble |
Associates the passed double value with the specified key in this object.
|
| PutDoubleArray |
Associates the passed array of doubles with the specified key in this object.
|
| PutFloat |
Associates the passed float value with the specified key in this object.
|
| PutFloatArray |
Associates the passed array of floats with the specified key in this object.
|
| PutInt |
Associates the passed integer value with the specified key in this object.
|
| PutIntArray |
Associates the passed array of integers with the specified key in this object.
|
| PutLong |
Associates the passed long value with the specified key in this object.
|
| PutLongArray |
Associates the passed array of longs with the specified key in this object.
|
| PutSFSArray |
Associates the passed ISFSArray object with the specified key in this object.
|
| PutSFSObject |
Associates the passed ISFSObject object with the specified key in this object.
|
| PutShort |
Associates the passed short value with the specified key in this object.
|
| PutShortArray |
Associates the passed array of shorts with the specified key in this object.
|
| PutText |
Associates the passed UTF-8 string value (max length: 2 GBytes) with the specified key in this object.
|
| PutUtfString |
Associates the passed UTF-8 string value (max length: 32 KBytes) with the specified key in this object.
|
| PutUtfStringArray |
Associates the passed array of UTF-8 strings with the specified key in this object.
|
| RemoveElement |
Removes the element corresponding to the passed key from this object.
|
| Size |
Indicates the number of elements in this object.
|
| ToBinary |
Provides the binary form of this object.
|
| ToJson |
Provides the JSON representation of this object.
|
Remarks
This class can be thought of as a specialized Dictionary/Map object that can contain any type of data.
The advantage of using the SFSObject class (for example when sending an ExtensionRequest request) is that you can fine tune the way your data is transmitted over the network.
For instance, a number like 100 can be transmitted as a normal integer (which takes 32 bits), but also a short (16 bit) or even a byte (8 bit).
SFSObject 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.
NOTE: UTF-8/multi-byte strings are not supported in key names. In other words you should restrict key names to standard ASCII characters. It is also recommended to keep key names very short to save bandwidth.
See Also