AtomicNET : AtomicEngine Namespace

HttpRequest Class

An HTTP connection with response data stream.

Syntax

public class HttpRequest : RefCounted, Deserializer

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Members

See Also: Inherited members from RefCounted.

Public Constructors

Documentation for this section has not yet been entered.

Public Fields

nativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)

Public Properties

[read-only]
AvailableSize uint . Documentation for this section has not yet been entered.
[read-only]
Checksum uint . Documentation for this section has not yet been entered.
[read-only]
Eof bool . Documentation for this section has not yet been entered.
[read-only]
Error string . Documentation for this section has not yet been entered.
InstantiationType InstantiationType . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
Name string . Documentation for this section has not yet been entered.
[read-only]
NativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
Open bool . Documentation for this section has not yet been entered.
[read-only]
Position uint . Documentation for this section has not yet been entered.
[read-only]
Size uint . Documentation for this section has not yet been entered.
[read-only]
State HttpRequestState . Documentation for this section has not yet been entered.
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
URL string . Documentation for this section has not yet been entered.
[read-only]
Verb string . Documentation for this section has not yet been entered.

Public Methods

AddRef ()
Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
AddRefSilent ()
Increment reference count. Do not call any lifetime book keeping (Inherited from RefCounted.)
static
csb_Atomic_HttpRequest_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
GetAvailableSize () : uint
Return amount of bytes in the read buffer.
GetChecksum () : uint
Return a checksum if applicable.
GetError () : string
Return error. Only non-empty in the error state.
GetInstantiationType () : InstantiationType
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetName () : string
Return name of the stream.
GetPosition () : uint
Return current position.
GetSize () : uint
Return size.
GetState () : HttpRequestState
Return connection state.
GetTypeName () : string
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetURL () : string
Return URL used in the request.
GetVerb () : string
Return verb used in the request. Default GET if empty verb specified on construction.
IsEof () : bool
Return whether all response data has been read.
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
IsOpen () : bool
Return whether connection is in the open state.
ReadBool () : bool
Read a bool.
ReadBoundingBox () : BoundingBox
Read a bounding box.
ReadByte () : char
Read an 8-bit integer.
ReadColor () : Color
Read a color.
ReadDouble () : float
Read a double.
ReadFileID () : string
Read a four-letter file ID.
ReadFloat () : float
Read a float.
ReadInt () : int
Read a 32-bit integer.
ReadInt64 () : long
Read a 64-bit integer.
ReadIntRect () : IntRect
Read an IntRect.
ReadIntVector2 () : IntVector2
Read an IntVector2.
ReadLine () : string
Read a text line.
ReadNetID () : uint
Read a 24-bit network object ID.
ReadPackedQuaternion () : Quaternion
Read a quaternion with each component packed in 16 bits.
ReadPackedVector3 (float) : Vector3
Read a Vector3 packed into 3 x 16 bits with the specified maximum absolute range.
ReadQuaternion () : Quaternion
Read a quaternion.
ReadRect () : Rect
Read a Rect.
ReadShort () : short
Read a 16-bit integer.
ReadString () : string
Read a null-terminated string.
ReadStringHash () : StringHash
Read a 32-bit StringHash.
ReadUByte () : byte
Read an 8-bit unsigned integer.
ReadUInt () : uint
Read a 32-bit unsigned integer.
ReadUInt64 () : long
Read a 64-bit unsigned integer.
ReadUShort () : ushort
Read a 16-bit unsigned integer.
ReadVector2 () : Vector2
Read a Vector2.
ReadVector3 () : Vector3
Read a Vector3.
ReadVector4 () : Vector4
Read a Vector4.
ReadVLE () : uint
Read a variable-length encoded unsigned integer, which can use 29 bits maximum.
Refs () : int
Return reference count. (Inherited from RefCounted.)
ReleaseRef ()
Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
Seek (uint) : uint
Set position from the beginning of the stream. Not supported.
SetInstantiationType (InstantiationType)
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
ThreadFunction ()
Process the connection in the worker thread until closed.
WeakRefs () : int
Return weak reference count. (Inherited from RefCounted.)

Member Details

HttpRequest Constructor

Documentation for this section has not yet been entered.

Syntax

public HttpRequest (IntPtr native)

Parameters

native
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

AvailableSize Property

Documentation for this section has not yet been entered.

Syntax

public uint AvailableSize { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Checksum Property

Documentation for this section has not yet been entered.

Syntax

public uint Checksum { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

csb_Atomic_HttpRequest_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

public static IntPtr csb_Atomic_HttpRequest_GetClassIDStatic ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Eof Property

Documentation for this section has not yet been entered.

Syntax

public bool Eof { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Error Property

Documentation for this section has not yet been entered.

Syntax

public string Error { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetAvailableSize Method

Return amount of bytes in the read buffer.

Syntax

public uint GetAvailableSize ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetChecksum Method

Return a checksum if applicable.

Syntax

public virtual uint GetChecksum ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetError Method

Return error. Only non-empty in the error state.

Syntax

public string GetError ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetName Method

Return name of the stream.

Syntax

public virtual string GetName ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetPosition Method

Return current position.

Syntax

public uint GetPosition ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetSize Method

Return size.

Syntax

public uint GetSize ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetState Method

Return connection state.

Syntax

public HttpRequestState GetState ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetURL Method

Return URL used in the request.

Syntax

public string GetURL ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetVerb Method

Return verb used in the request. Default GET if empty verb specified on construction.

Syntax

public string GetVerb ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsEof Method

Return whether all response data has been read.

Syntax

public virtual bool IsEof ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsOpen Method

Return whether connection is in the open state.

Syntax

public bool IsOpen ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Name Property

Documentation for this section has not yet been entered.

Syntax

public string Name { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Open Property

Documentation for this section has not yet been entered.

Syntax

public bool Open { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Position Property

Documentation for this section has not yet been entered.

Syntax

public uint Position { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadBool Method

Read a bool.

Syntax

public bool ReadBool ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadBoundingBox Method

Read a bounding box.

Syntax

public BoundingBox ReadBoundingBox ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadByte Method

Read an 8-bit integer.

Syntax

public char ReadByte ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadColor Method

Read a color.

Syntax

public Color ReadColor ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadDouble Method

Read a double.

Syntax

public float ReadDouble ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadFileID Method

Read a four-letter file ID.

Syntax

public string ReadFileID ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadFloat Method

Read a float.

Syntax

public float ReadFloat ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadInt Method

Read a 32-bit integer.

Syntax

public int ReadInt ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadInt64 Method

Read a 64-bit integer.

Syntax

public long ReadInt64 ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadIntRect Method

Read an IntRect.

Syntax

public IntRect ReadIntRect ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadIntVector2 Method

Read an IntVector2.

Syntax

public IntVector2 ReadIntVector2 ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadLine Method

Read a text line.

Syntax

public string ReadLine ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadNetID Method

Read a 24-bit network object ID.

Syntax

public uint ReadNetID ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadPackedQuaternion Method

Read a quaternion with each component packed in 16 bits.

Syntax

public Quaternion ReadPackedQuaternion ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadPackedVector3 Method

Read a Vector3 packed into 3 x 16 bits with the specified maximum absolute range.

Syntax

public Vector3 ReadPackedVector3 (float maxAbsCoord)

Parameters

maxAbsCoord
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadQuaternion Method

Read a quaternion.

Syntax

public Quaternion ReadQuaternion ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadRect Method

Read a Rect.

Syntax

public Rect ReadRect ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadShort Method

Read a 16-bit integer.

Syntax

public short ReadShort ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadString Method

Read a null-terminated string.

Syntax

public string ReadString ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadStringHash Method

Read a 32-bit StringHash.

Syntax

public StringHash ReadStringHash ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadUByte Method

Read an 8-bit unsigned integer.

Syntax

public byte ReadUByte ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadUInt Method

Read a 32-bit unsigned integer.

Syntax

public uint ReadUInt ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadUInt64 Method

Read a 64-bit unsigned integer.

Syntax

public long ReadUInt64 ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadUShort Method

Read a 16-bit unsigned integer.

Syntax

public ushort ReadUShort ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadVector2 Method

Read a Vector2.

Syntax

public Vector2 ReadVector2 ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadVector3 Method

Read a Vector3.

Syntax

public Vector3 ReadVector3 ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadVector4 Method

Read a Vector4.

Syntax

public Vector4 ReadVector4 ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadVLE Method

Read a variable-length encoded unsigned integer, which can use 29 bits maximum.

Syntax

public uint ReadVLE ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Seek Method

Set position from the beginning of the stream. Not supported.

Syntax

public virtual uint Seek (uint position)

Parameters

position
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Size Property

Documentation for this section has not yet been entered.

Syntax

public uint Size { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

State Property

Documentation for this section has not yet been entered.

Syntax

public HttpRequestState State { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ThreadFunction Method

Process the connection in the worker thread until closed.

Syntax

public virtual void ThreadFunction ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

URL Property

Documentation for this section has not yet been entered.

Syntax

public string URL { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Verb Property

Documentation for this section has not yet been entered.

Syntax

public string Verb { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0