Arci.Networking
Arci.Networking.Builder.PacketBuilder Class Reference

Builder for Packet class More...

Public Member Functions

 PacketBuilder (Packet packet)
 Creates new instance of packet builder More...
 
PacketBuilder FlushBits ()
 Flushes bits in builded packet More...
 
PacketBuilder WriteGuidByteStreamInOrder (PacketGuid guid, params int[] indexes)
 Writes guid byte stream in specified order More...
 
PacketBuilder WriteGuidBitStreamInOrder (PacketGuid guid, params int[] indexes)
 Writes guid bit stream in specified order More...
 
PacketBuilder Write (PacketGuid guid)
 Writes guid to packet More...
 
PacketBuilder Write (string val, Encoding encoding)
 Writes string value More...
 
PacketBuilder Write (ByteBuffer buffer)
 Writes bytebuffer to packet More...
 
PacketBuilder Write (Guid guid, string format)
 Writes guid into packet More...
 
PacketBuilder WriteBit (bool bit)
 Writes bit value to stream More...
 
Packet Build ()
 Builds packet More...
 
PacketBuilder Write (SByte val)
 Writes SByte value to packet More...
 
PacketBuilder Write (Int16 val)
 Writes Int16 value to packet More...
 
PacketBuilder Write (Int32 val)
 Writes Int32 value to packet More...
 
PacketBuilder Write (Int64 val)
 Writes Int64 value to packet More...
 
PacketBuilder Write (Byte val)
 Writes Byte value to packet More...
 
PacketBuilder Write (UInt16 val)
 Writes UInt16 value to packet More...
 
PacketBuilder Write (UInt32 val)
 Writes UInt32 value to packet More...
 
PacketBuilder Write (UInt64 val)
 Writes UInt64 value to packet More...
 
PacketBuilder Write (Byte[] val)
 Writes Byte[] value to packet More...
 
PacketBuilder Write (Single val)
 Writes Single value to packet More...
 
PacketBuilder Write (Double val)
 Writes Double value to packet More...
 
PacketBuilder Write (Decimal val)
 Writes Decimal value to packet More...
 
PacketBuilder Write (String val)
 Writes String value to packet More...
 
PacketBuilder Write (Guid val)
 Writes Guid value to packet More...
 
PacketBuilder WriteBit (SByte bit)
 Writes 1 if SByte value is different from 0, otherwise writes 0 More...
 
PacketBuilder WriteBits (SByte value, byte bitsCount)
 Writes value with specified number of bits More...
 
PacketBuilder WriteBit (Int16 bit)
 Writes 1 if Int16 value is different from 0, otherwise writes 0 More...
 
PacketBuilder WriteBits (Int16 value, byte bitsCount)
 Writes value with specified number of bits More...
 
PacketBuilder WriteBit (Int32 bit)
 Writes 1 if Int32 value is different from 0, otherwise writes 0 More...
 
PacketBuilder WriteBits (Int32 value, byte bitsCount)
 Writes value with specified number of bits More...
 
PacketBuilder WriteBit (Int64 bit)
 Writes 1 if Int64 value is different from 0, otherwise writes 0 More...
 
PacketBuilder WriteBits (Int64 value, byte bitsCount)
 Writes value with specified number of bits More...
 
PacketBuilder WriteBit (Byte bit)
 Writes 1 if Byte value is different from 0, otherwise writes 0 More...
 
PacketBuilder WriteBits (Byte value, byte bitsCount)
 Writes value with specified number of bits More...
 
PacketBuilder WriteBit (UInt16 bit)
 Writes 1 if UInt16 value is different from 0, otherwise writes 0 More...
 
PacketBuilder WriteBits (UInt16 value, byte bitsCount)
 Writes value with specified number of bits More...
 
PacketBuilder WriteBit (UInt32 bit)
 Writes 1 if UInt32 value is different from 0, otherwise writes 0 More...
 
PacketBuilder WriteBits (UInt32 value, byte bitsCount)
 Writes value with specified number of bits More...
 
PacketBuilder WriteBit (UInt64 bit)
 Writes 1 if UInt64 value is different from 0, otherwise writes 0 More...
 
PacketBuilder WriteBits (UInt64 value, byte bitsCount)
 Writes value with specified number of bits More...
 

Detailed Description

Builder for Packet class

Constructor & Destructor Documentation

§ PacketBuilder()

Arci.Networking.Builder.PacketBuilder.PacketBuilder ( Packet  packet)
inline

Creates new instance of packet builder

Parameters
packetPacket to build
Exceptions
ArgumentNullExceptionThrown if packet is null

Member Function Documentation

§ Build()

Packet Arci.Networking.Builder.PacketBuilder.Build ( )
inline

Builds packet

Returns
Builded packet

§ FlushBits()

PacketBuilder Arci.Networking.Builder.PacketBuilder.FlushBits ( )
inline

Flushes bits in builded packet

Returns
This PacketBuilder

§ Write() [1/18]

PacketBuilder Arci.Networking.Builder.PacketBuilder.Write ( SByte  val)
inline

Writes SByte value to packet

Parameters
valValue to be written
Returns
This PacketBuilder

§ Write() [2/18]

PacketBuilder Arci.Networking.Builder.PacketBuilder.Write ( Int16  val)
inline

Writes Int16 value to packet

Parameters
valValue to be written
Returns
This PacketBuilder

§ Write() [3/18]

PacketBuilder Arci.Networking.Builder.PacketBuilder.Write ( Int32  val)
inline

Writes Int32 value to packet

Parameters
valValue to be written
Returns
This PacketBuilder

§ Write() [4/18]

PacketBuilder Arci.Networking.Builder.PacketBuilder.Write ( Int64  val)
inline

Writes Int64 value to packet

Parameters
valValue to be written
Returns
This PacketBuilder

§ Write() [5/18]

PacketBuilder Arci.Networking.Builder.PacketBuilder.Write ( Byte  val)
inline

Writes Byte value to packet

Parameters
valValue to be written
Returns
This PacketBuilder

§ Write() [6/18]

PacketBuilder Arci.Networking.Builder.PacketBuilder.Write ( PacketGuid  guid)
inline

Writes guid to packet

Parameters
guidGuid to be written
Returns
This PacketBuilder

§ Write() [7/18]

PacketBuilder Arci.Networking.Builder.PacketBuilder.Write ( UInt16  val)
inline

Writes UInt16 value to packet

Parameters
valValue to be written
Returns
This PacketBuilder

§ Write() [8/18]

PacketBuilder Arci.Networking.Builder.PacketBuilder.Write ( string  val,
Encoding  encoding 
)
inline

Writes string value

Parameters
valValue to be written
encodingEncoding type of string. If null provided then ASCII will be used
Returns
This PacketBuilder

§ Write() [9/18]

PacketBuilder Arci.Networking.Builder.PacketBuilder.Write ( UInt32  val)
inline

Writes UInt32 value to packet

Parameters
valValue to be written
Returns
This PacketBuilder

§ Write() [10/18]

PacketBuilder Arci.Networking.Builder.PacketBuilder.Write ( ByteBuffer  buffer)
inline

Writes bytebuffer to packet

Parameters
bufferBuffer to be written
Returns
This PacketBuilder

§ Write() [11/18]

PacketBuilder Arci.Networking.Builder.PacketBuilder.Write ( UInt64  val)
inline

Writes UInt64 value to packet

Parameters
valValue to be written
Returns
This PacketBuilder

§ Write() [12/18]

PacketBuilder Arci.Networking.Builder.PacketBuilder.Write ( Guid  guid,
string  format 
)
inline

Writes guid into packet

Parameters
guidGuid to be written
formatGuid format

§ Write() [13/18]

PacketBuilder Arci.Networking.Builder.PacketBuilder.Write ( Byte []  val)
inline

Writes Byte[] value to packet

Parameters
valValue to be written
Returns
This PacketBuilder

§ Write() [14/18]

PacketBuilder Arci.Networking.Builder.PacketBuilder.Write ( Single  val)
inline

Writes Single value to packet

Parameters
valValue to be written
Returns
This PacketBuilder

§ Write() [15/18]

PacketBuilder Arci.Networking.Builder.PacketBuilder.Write ( Double  val)
inline

Writes Double value to packet

Parameters
valValue to be written
Returns
This PacketBuilder

§ Write() [16/18]

PacketBuilder Arci.Networking.Builder.PacketBuilder.Write ( Decimal  val)
inline

Writes Decimal value to packet

Parameters
valValue to be written
Returns
This PacketBuilder

§ Write() [17/18]

PacketBuilder Arci.Networking.Builder.PacketBuilder.Write ( String  val)
inline

Writes String value to packet

Parameters
valValue to be written
Returns
This PacketBuilder

§ Write() [18/18]

PacketBuilder Arci.Networking.Builder.PacketBuilder.Write ( Guid  val)
inline

Writes Guid value to packet

Parameters
valValue to be written
Returns
This PacketBuilder

§ WriteBit() [1/9]

PacketBuilder Arci.Networking.Builder.PacketBuilder.WriteBit ( bool  bit)
inline

Writes bit value to stream

Parameters
bitValue to be written
Returns
This PacketBuilder

§ WriteBit() [2/9]

PacketBuilder Arci.Networking.Builder.PacketBuilder.WriteBit ( SByte  bit)
inline

Writes 1 if SByte value is different from 0, otherwise writes 0

Parameters
bitValue to be written
Returns
This PacketBuilder

§ WriteBit() [3/9]

PacketBuilder Arci.Networking.Builder.PacketBuilder.WriteBit ( Int16  bit)
inline

Writes 1 if Int16 value is different from 0, otherwise writes 0

Parameters
bitValue to be written
Returns
This PacketBuilder

§ WriteBit() [4/9]

PacketBuilder Arci.Networking.Builder.PacketBuilder.WriteBit ( Int32  bit)
inline

Writes 1 if Int32 value is different from 0, otherwise writes 0

Parameters
bitValue to be written
Returns
This PacketBuilder

§ WriteBit() [5/9]

PacketBuilder Arci.Networking.Builder.PacketBuilder.WriteBit ( Int64  bit)
inline

Writes 1 if Int64 value is different from 0, otherwise writes 0

Parameters
bitValue to be written
Returns
This PacketBuilder

§ WriteBit() [6/9]

PacketBuilder Arci.Networking.Builder.PacketBuilder.WriteBit ( Byte  bit)
inline

Writes 1 if Byte value is different from 0, otherwise writes 0

Parameters
bitValue to be written
Returns
This PacketBuilder

§ WriteBit() [7/9]

PacketBuilder Arci.Networking.Builder.PacketBuilder.WriteBit ( UInt16  bit)
inline

Writes 1 if UInt16 value is different from 0, otherwise writes 0

Parameters
bitValue to be written
Returns
This PacketBuilder

§ WriteBit() [8/9]

PacketBuilder Arci.Networking.Builder.PacketBuilder.WriteBit ( UInt32  bit)
inline

Writes 1 if UInt32 value is different from 0, otherwise writes 0

Parameters
bitValue to be written
Returns
This PacketBuilder

§ WriteBit() [9/9]

PacketBuilder Arci.Networking.Builder.PacketBuilder.WriteBit ( UInt64  bit)
inline

Writes 1 if UInt64 value is different from 0, otherwise writes 0

Parameters
bitValue to be written
Returns
This PacketBuilder

§ WriteBits() [1/8]

PacketBuilder Arci.Networking.Builder.PacketBuilder.WriteBits ( SByte  value,
byte  bitsCount 
)
inline

Writes value with specified number of bits

Parameters
valueValue to be written
bitsCountNumber of bits that value should written with
Returns
This PacketBuilder

§ WriteBits() [2/8]

PacketBuilder Arci.Networking.Builder.PacketBuilder.WriteBits ( Int16  value,
byte  bitsCount 
)
inline

Writes value with specified number of bits

Parameters
valueValue to be written
bitsCountNumber of bits that value should written with
Returns
This PacketBuilder

§ WriteBits() [3/8]

PacketBuilder Arci.Networking.Builder.PacketBuilder.WriteBits ( Int32  value,
byte  bitsCount 
)
inline

Writes value with specified number of bits

Parameters
valueValue to be written
bitsCountNumber of bits that value should written with
Returns
This PacketBuilder

§ WriteBits() [4/8]

PacketBuilder Arci.Networking.Builder.PacketBuilder.WriteBits ( Int64  value,
byte  bitsCount 
)
inline

Writes value with specified number of bits

Parameters
valueValue to be written
bitsCountNumber of bits that value should written with
Returns
This PacketBuilder

§ WriteBits() [5/8]

PacketBuilder Arci.Networking.Builder.PacketBuilder.WriteBits ( Byte  value,
byte  bitsCount 
)
inline

Writes value with specified number of bits

Parameters
valueValue to be written
bitsCountNumber of bits that value should written with
Returns
This PacketBuilder

§ WriteBits() [6/8]

PacketBuilder Arci.Networking.Builder.PacketBuilder.WriteBits ( UInt16  value,
byte  bitsCount 
)
inline

Writes value with specified number of bits

Parameters
valueValue to be written
bitsCountNumber of bits that value should written with
Returns
This PacketBuilder

§ WriteBits() [7/8]

PacketBuilder Arci.Networking.Builder.PacketBuilder.WriteBits ( UInt32  value,
byte  bitsCount 
)
inline

Writes value with specified number of bits

Parameters
valueValue to be written
bitsCountNumber of bits that value should written with
Returns
This PacketBuilder

§ WriteBits() [8/8]

PacketBuilder Arci.Networking.Builder.PacketBuilder.WriteBits ( UInt64  value,
byte  bitsCount 
)
inline

Writes value with specified number of bits

Parameters
valueValue to be written
bitsCountNumber of bits that value should written with
Returns
This PacketBuilder

§ WriteGuidBitStreamInOrder()

PacketBuilder Arci.Networking.Builder.PacketBuilder.WriteGuidBitStreamInOrder ( PacketGuid  guid,
params int []  indexes 
)
inline

Writes guid bit stream in specified order

Parameters
guidGuid to be written
indexesOrder
Returns
This PacketBuilder

§ WriteGuidByteStreamInOrder()

PacketBuilder Arci.Networking.Builder.PacketBuilder.WriteGuidByteStreamInOrder ( PacketGuid  guid,
params int []  indexes 
)
inline

Writes guid byte stream in specified order

Parameters
guidGuid to be written
indexesOrder
Returns
This PacketBuilder