AMPS C# Client  5.3.3.4
AMPS C# Client for .NET
Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
AMPS.Client.Fields.BookmarkField Class Reference
+ Inheritance diagram for AMPS.Client.Fields.BookmarkField:

Public Member Functions

bool isTimestamp ()
 
bool isRange ()
 
override string ToString ()
 
ulong getPublisherId ()
 
ulong getSequenceNumber ()
 
IList< BookmarkField > parseBookmarkList ()
 
Object clone ()
 
new BookmarkField copy ()
 
override int GetHashCode ()
 
- Public Member Functions inherited from AMPS.Client.Fields.StringField
 StringField (string value)
 
virtual string getValue (Encoding decoder)
 
bool getValue (byte[] v)
 
bool getValue (CommandId v)
 
void setValue (byte[] v, int offset, int length)
 
void setValue (CommandId v)
 
void setValue (string v, Encoding encoder)
 
- Public Member Functions inherited from AMPS.Client.Fields.Field
 Field (string value)
 
 Field (byte[] buffer, int position, int length)
 
void set (byte[] buffer, int position, int length)
 
void set (byte[] buffer)
 
bool isNull ()
 
void reset ()
 
byte byteAt (int i)
 
override bool Equals (Object obj)
 
override int GetHashCode ()
 
Field copy ()
 
virtual void copyFrom (Field f)
 

Static Public Attributes

const int MAX_BOOKMARK_LENGTH = 42
 
const int MAX_TIMESTAMP_LENGTH = 24
 
const int MIN_TIMESTAMP_LENGTH = 10
 

Protected Member Functions

 BookmarkField (byte[] buffer, int position, int length)
 
- Protected Member Functions inherited from AMPS.Client.Fields.StringField
 StringField (byte[] buffer, int position, int length)
 

Additional Inherited Members

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

Member Function Documentation

◆ clone()

Object AMPS.Client.Fields.BookmarkField.clone ( )
inline

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

◆ getPublisherId()

ulong AMPS.Client.Fields.BookmarkField.getPublisherId ( )
inline

Returns the publisher id for the bookmark or 0 if it's a timestamp.

◆ getSequenceNumber()

ulong AMPS.Client.Fields.BookmarkField.getSequenceNumber ( )
inline

Returns the sequence number for the bookmark or 0 if it's a timestamp.

◆ isRange()

bool AMPS.Client.Fields.BookmarkField.isRange ( )
inline

Identifies if this bookmark likely represents a range. Only checks for starting [( and ending ]) so not a full validation

◆ isTimestamp()

bool AMPS.Client.Fields.BookmarkField.isTimestamp ( )
inline

Identifies if this bookmark represents a timestamp.

◆ ToString()

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

Returns the bookmark as a string.

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