AMPS C# Client  5.3.5.0
AMPS C# Client for .NET
AMPS.Client.Fields.BookmarkRangeField Class Reference

Field data for a AMPS.Client.Message consisting of a bookmark This is the AMPS Bookmark for a Message going to the server. More...

+ Inheritance diagram for AMPS.Client.Fields.BookmarkRangeField:

Public Member Functions

 BookmarkRangeField ()
 Constructs a new empty BookmarkRangeField. More...
 
override void copyFrom (Field f)
 Provides a way to make this object a duplicate of f if f represents a valid bookmark range. More...
 
bool isValid ()
 Checks if the bookmark range is valid. More...
 
BookmarkField getStart ()
 Returns the start bookmark of the range. More...
 
BookmarkField getEnd ()
 Returns the end bookmark of the range. More...
 
bool isStartInclusive ()
 Returns if the start of the range in inclusive. More...
 
bool isEndInclusive ()
 Returns if the end of the range in inclusive. More...
 
bool isStartExclusive ()
 Returns if the start of the range in exclusive. More...
 
bool isEndExclusive ()
 Returns if the end of the range in exclusive. More...
 
void replaceStart (BookmarkField start_, bool makeExclusive=true)
 Replaces the start bookmark of the range. More...
 
override string ToString ()
 Returns the entire bookmark rangs as a string. More...
 
new Object clone ()
 Provides a way to duplicate this object and retain its specific type (and hashcode() implementation). More...
 
new BookmarkRangeField copy ()
 Override base class's copy() method appropriately, so we don't inadvertently mix BookmarkRangeFields and Fields up – they have different hashCode implementations. More...
 
override int GetHashCode ()
 Computes the hash code for this BookmarkRangeField. More...
 
- Public Member Functions inherited from AMPS.Client.Fields.BookmarkField
 BookmarkField ()
 Default constructor. More...
 
 BookmarkField (string bookmark)
 Constructor with string version of a bookmark. More...
 
bool isTimestamp ()
 Indicates if this bookmark represents a timestamp. More...
 
bool isRange ()
 Indicates whether this bookmark likely represents a range, using only a simple check for brackets or parantheses. More...
 
bool isBookmarkList ()
 Identifies if this bookmark is a list of , separated bookmarks. More...
 
override string ToString ()
 Returns the bookmark as a string. More...
 
ulong getPublisherId ()
 Gets the numeric publisher id for this bookmark. More...
 
ulong getSequenceNumber ()
 Returns the sequence number for the bookmark or 0 if it's a timestamp. More...
 
IList< BookmarkFieldparseBookmarkList ()
 Parses a bookmark list to individual bookmarks. More...
 
Object clone ()
 Provides a way to duplicate this object and retain its specific type (and hashcode() implementation). More...
 
new BookmarkField copy ()
 Override base class's copy() method appropriately, so we don't inadvertently mix BookmarkField and Field up – they have different hashCode implementations. More...
 
override int GetHashCode ()
 
- Public Member Functions inherited from AMPS.Client.Fields.StringField
 StringField (string value)
 Initializes a new instance of the StringField class with the specified string value. More...
 
 StringField ()
 Default constructor. More...
 
virtual string getValue (Encoding decoder)
 Returns a string representation of the Field value, where the bytes are interpreted by using the specified decoder. More...
 
bool getValue (byte[] v)
 Writes the byte value of this instance into the specified byte buffer, if the value is not null. More...
 
bool getValue (CommandId v)
 Writes the byte value of this instance into the specified command ID object, if the value is not null. More...
 
void setValue (byte[] v, int offset, int length)
 Sets the value of this instance with the specified region of a byte buffer. More...
 
void setValue (CommandId v)
 Sets the value of this instance from the specified command ID. More...
 
void setValue (string v, Encoding encoder)
 Sets the value of this instance from the specified string. The characters of the string are interpreted using the specified encoder. This method makes its own copy of the bytes. More...
 
- Public Member Functions inherited from AMPS.Client.Fields.Field
 Field ()
 Default construntotor. More...
 
 Field (string value)
 Constructs an instance with the bytes of the specified string value. The string is interpreted as the UTF-8 representation. More...
 
 Field (byte[] buffer, int position, int length)
 Constructs an instance with the specified region of a byte buffer. Note: the bytes are not copied from the buffer. The specified buffer region is referenced by this instance. More...
 
void set (byte[] buffer, int position, int length)
 Sets the value of this instance with the specified region of a byte buffer. Note: the bytes are not copied from the buffer. The specified buffer region is referenced by this instance. More...
 
void set (byte[] buffer)
 Sets the value of this instance with the specified buffer. Note: the bytes are not copied from the buffer. The buffer is referenced by this instance. More...
 
bool isNull ()
 Indicates whether this instance's value is null. More...
 
void reset ()
 Resets the value of this instance to null. More...
 
byte byteAt (int i)
 Returns the byte at position plus index i. More...
 
override bool Equals (Object obj)
 Default implementation for Object#equals for a Field. For two Fields to be considered equal, their values must have the same length and all bytes in the value must be equal. More...
 
override int GetHashCode ()
 Gets the hash code for the Field. More...
 
Field copy ()
 Constructs a new Field and sets its value to a deep copy of this instance. More...
 

Protected Member Functions

 BookmarkRangeField (byte[] buffer, int position, int length)
 Constructs a new BookmarkRangeField with the provided buffer, position, and length. More...
 
- Protected Member Functions inherited from AMPS.Client.Fields.BookmarkField
 BookmarkField (byte[] buffer, int position, int length)
 Constructor with specified buffer, position, and length. More...
 
- Protected Member Functions inherited from AMPS.Client.Fields.StringField
 StringField (byte[] buffer, int position, int length)
 Initializes a new instance of the StringField class with the specified buffer, position, and length. More...
 

Additional Inherited Members

- Public Attributes inherited from AMPS.Client.Fields.Field
byte[] buffer = null
 
int position = 0
 
int length = 0
 
- Static Public Attributes inherited from AMPS.Client.Fields.BookmarkField
const int MAX_BOOKMARK_LENGTH = 42
 
const int MAX_TIMESTAMP_LENGTH = 24
 
const int MIN_TIMESTAMP_LENGTH = 10
 
- Static Protected Attributes inherited from AMPS.Client.Fields.StringField
const string LATIN1 = "ISO-8859-1"
 
const byte LATIN1_ZERO = 48
 

Detailed Description

Field data for a AMPS.Client.Message consisting of a bookmark This is the AMPS Bookmark for a Message going to the server.

Constructor & Destructor Documentation

◆ BookmarkRangeField() [1/2]

AMPS.Client.Fields.BookmarkRangeField.BookmarkRangeField ( )
inline

Constructs a new empty BookmarkRangeField.

◆ BookmarkRangeField() [2/2]

AMPS.Client.Fields.BookmarkRangeField.BookmarkRangeField ( byte[]  buffer,
int  position,
int  length 
)
inlineprotected

Constructs a new BookmarkRangeField with the provided buffer, position, and length.

Parameters
bufferThe buffer containing the bookmark range.
positionThe starting position of the bookmark range within the buffer
lengthThe length of the bookmark range.

Member Function Documentation

◆ clone()

new Object AMPS.Client.Fields.BookmarkRangeField.clone ( )
inline

Provides a way to duplicate this object and retain its specific type (and hashcode() implementation).

Returns
A new instance of BookmarkRangeField with the same data.

◆ copy()

new BookmarkRangeField AMPS.Client.Fields.BookmarkRangeField.copy ( )
inline

Override base class's copy() method appropriately, so we don't inadvertently mix BookmarkRangeFields and Fields up – they have different hashCode implementations.

◆ copyFrom()

override void AMPS.Client.Fields.BookmarkRangeField.copyFrom ( Field  f)
inlinevirtual

Provides a way to make this object a duplicate of f if f represents a valid bookmark range.

Reimplemented from AMPS.Client.Fields.Field.

◆ getEnd()

BookmarkField AMPS.Client.Fields.BookmarkRangeField.getEnd ( )
inline

Returns the end bookmark of the range.

◆ GetHashCode()

override int AMPS.Client.Fields.BookmarkRangeField.GetHashCode ( )
inline

Computes the hash code for this BookmarkRangeField.

Returns
The hash code value for this BookmarkRangeField.

◆ getStart()

BookmarkField AMPS.Client.Fields.BookmarkRangeField.getStart ( )
inline

Returns the start bookmark of the range.

◆ isEndExclusive()

bool AMPS.Client.Fields.BookmarkRangeField.isEndExclusive ( )
inline

Returns if the end of the range in exclusive.

◆ isEndInclusive()

bool AMPS.Client.Fields.BookmarkRangeField.isEndInclusive ( )
inline

Returns if the end of the range in inclusive.

◆ isStartExclusive()

bool AMPS.Client.Fields.BookmarkRangeField.isStartExclusive ( )
inline

Returns if the start of the range in exclusive.

◆ isStartInclusive()

bool AMPS.Client.Fields.BookmarkRangeField.isStartInclusive ( )
inline

Returns if the start of the range in inclusive.

◆ isValid()

bool AMPS.Client.Fields.BookmarkRangeField.isValid ( )
inline

Checks if the bookmark range is valid.

Returns
True if the bookmark range is valid, false otherwise.

◆ replaceStart()

void AMPS.Client.Fields.BookmarkRangeField.replaceStart ( BookmarkField  start_,
bool  makeExclusive = true 
)
inline

Replaces the start bookmark of the range.

Parameters
start_The new start bookmark.
makeExclusiveIndicates whether the new start should be exclusive.

◆ ToString()

override string AMPS.Client.Fields.BookmarkRangeField.ToString ( )
inline

Returns the entire bookmark rangs as a string.


The documentation for this class was generated from the following file: