This class enables a client to maintain a copy of an event, make changes to the properties and then when commit is called only the changes are published to the server. More...
Public Member Functions | |
void | commitChanges () |
Writes all changes to the server and resets any internal counts, timers and copies. More... | |
void | commitChanges (bool Replace) |
Writes all changes to the server and resets any internal counts, timers and copies More... | |
int | getChangeSize () |
Returns the number of changes made since the last commitChanges was called More... | |
byte[] | getData () |
Returns the byte[] data payload of the event More... | |
string | getPrimaryKeyName () |
Retrieves the name of the primary key name used for this event. More... | |
object | getPrimaryKeyValue () |
Retrieves the unique value for the primary key used for this event More... | |
nEventProperties | getProperties () |
Retrieves the properties for the event. More... | |
string | getTag () |
Returns the string tag of the event More... | |
void | setData (byte[] data) |
Sets the byte[] data payload for the event More... | |
void | setTag (string tag) |
Sets the tag for the event. More... | |
long | timeSinceLastChange () |
Returns the time in milliseconds since the last change was made to the event. More... | |
This class enables a client to maintain a copy of an event, make changes to the properties and then when commit is called only the changes are published to the server.
This enables a mechanism whereby only changes are published and not full events
void com.pcbsys.nirvana.client.nRegisteredEvent.commitChanges | ( | ) |
Writes all changes to the server and resets any internal counts, timers and copies.
nSecurityException | User is not authorised for the function |
nSessionPausedException | The session is currently paused, please resume |
nIllegalArgumentException | Illegal parameter, check the message for more information |
nSessionNotConnectedException | Current session is not connected |
nTransactionException | thrown if any transactional errors occur |
nRequestTimedOutException | The server has not responded to the request in the timeout period |
nChannelNotFoundException | The channel specified could not be found |
nUnexpectedResponseException | Internal Error has occured, since we received a response from the server out of sequence |
void com.pcbsys.nirvana.client.nRegisteredEvent.commitChanges | ( | bool | Replace | ) |
Writes all changes to the server and resets any internal counts, timers and copies
Replace | , if true the server will replace the referenced event with a complete copy of this event and will not merge any data from previous events. |
nSecurityException | User is not authorised for the function |
nSessionPausedException | The session is currently paused, please resume |
nIllegalArgumentException | Illegal parameter, check the message for more information |
nSessionNotConnectedException | Current session is not connected |
nTransactionException | thrown if any transactional errors occur |
nRequestTimedOutException | The server has not responded to the request in the timeout period |
nChannelNotFoundException | The channel specified could not be found |
nUnexpectedResponseException | Internal Error has occured, since we received a response from the server out of sequence |
int com.pcbsys.nirvana.client.nRegisteredEvent.getChangeSize | ( | ) |
Returns the number of changes made since the last commitChanges was called
byte [] com.pcbsys.nirvana.client.nRegisteredEvent.getData | ( | ) |
Returns the byte[] data payload of the event
string com.pcbsys.nirvana.client.nRegisteredEvent.getPrimaryKeyName | ( | ) |
Retrieves the name of the primary key name used for this event.
This key name is setup during channel construction using the publish key API
object com.pcbsys.nirvana.client.nRegisteredEvent.getPrimaryKeyValue | ( | ) |
Retrieves the unique value for the primary key used for this event
nEventProperties com.pcbsys.nirvana.client.nRegisteredEvent.getProperties | ( | ) |
Retrieves the properties for the event.
The client can then change the key/value pairs in the properties. When the commitChanges() is called all changes will be sent to the server
string com.pcbsys.nirvana.client.nRegisteredEvent.getTag | ( | ) |
Returns the string tag of the event
void com.pcbsys.nirvana.client.nRegisteredEvent.setData | ( | byte[] | data | ) |
Sets the byte[] data payload for the event
data | a byte[] to be sent |
void com.pcbsys.nirvana.client.nRegisteredEvent.setTag | ( | string | tag | ) |
Sets the tag for the event.
tag | String representation of the tag to use |
long com.pcbsys.nirvana.client.nRegisteredEvent.timeSinceLastChange | ( | ) |
Returns the time in milliseconds since the last change was made to the event.
If no change then the function will return 0