Task Object | Syntax | Description |
maintain | Store.maintain("*"); Store.maintain("/customer/sales"); myChannel.maintain(); | Perform maintenance on a channel so that any purged events are removed from the channel or queue event store. |
publish | myChannel.publish("Byte array data", "tag", "key1=value1:key2:value2" ); | Publish an event to the channel / queue, using the given byte array, event tag and event dictionary values. |
purge | myChannel.purge(); myChannel.purge(0, 100000); myChannel.purge(0, 10000, "key1 = 'value1'"); | Purge all events on a channel, or events between a start and end eid, or using a purge filter. |
createChannel | myChannel.createChannel(0, 0, "P"); | Create the channel using the name it was declared as, and the ttl, capacity and type specified in the parameters |
createQueue | myChannel.createQueue(0, 0, "P"); | Create the queue using the name it was declared as, and the ttl, capacity and type specified in the parameters |
Task Object | Syntax | Description |
stop | myNHP.stop(); Interface.stop("nhp0"); | Stop the interface |
start | myNHP.start(); Interface.start("nhp0"); | Start The interface |
stopAll | Interface.stopAll(); | Stop all interfaces on the realm |
startAll | Interface.startAll(); | Start all interfaces on the realm |
authTime | myNHP.authTime(20000); myNHP.authTime("+10000"); | Set the interface authentication time to a value, or increase / decrease it by a value. |
backlog | myNHP.backlog(200); myNHP.backlog("+100"); | Set the interface backlog time to a value, or increase / decrease it by a value. |
autoStart | myNHP.autoStart("true"); myNHP.autoStart("false"); | Set whether an interface is automatically started when the realm is started. |
advertise | myNHP.advertise("true"); myNHP.advertise("false"); | Set whether an interface is available to clients using the admin API. |
certificateValidation | myNHP.certificateValidation("true"); myNHP.certificateValidation("false"); | Set whether an interface (SSL) requires clients to provide a certificate to authenticate. |
threads | myNHP.threads(10); myNHP.threads("+10"); | Set the interface accept threads to a value or increase / decrease it by a value. |
Task Object | Syntax | Description |
flush | mem.flush(true); mem.flush(false); | Cause the JVM to call garbage collection, and optionally release used memory |
Task Object | Syntax | Description |
dec | counter1.dec() | Decrement the counter by 1 |
inc | counter1.inc() | Increment the counter by 1 |
set | counter1.set(5) | Set the counter to a value |
reset | counter1.reset() | Reset the counter to 0 |
Task Object | Syntax | Description |
start | reportTimer.start() | Start the timer |
inc | reportTimer.stop() | Stop the timer |
reset | reportTimer.reset() | Reset the timer |
Trigger Object | Syntax | Description |
Global Values | ||
SchedulerPoolSize | myGlobal.SchedulerPoolSize(10); | The number of threads assigned to the scheduler |
MaxNoOfConnections | myGlobal.MaxNoOfConnections(-1); | Sets the maximum concurrent connections to the server, -1 indicates no restriction |
StatusBroadcast | myGlobal.StatusBroadcast(2000); | The number of ms between status events being published |
NHPTimeout | myGlobal.NHPTimeout(2000); | The number of milliseconds the server will wait for client authentication |
NHPScanTime | myGlobal.NHPScanTime(10000); | The number of milliseconds that the server will wait before scanning for client timeouts |
StampDictionary | myGlobal.StampDictionary(true); | Place Universal Messaging details into the dictionary (true/false) |
ExtendedMessageSelector | myGlobal.ExtendedMessageSelector (true); | If true, allows the server to use the extended message selector syntax (true/false) |
ConnectionDelay | myGlobal.ConnectionDelay(2000); | When the server has exceeded the connection count, how long to hold on to the connection before disconnecting |
SupportVersion2Clients | myGlobal.SupportVersion2Clients (true); | Allow the server to support older clients (true/false) |
SendRealmSummaryStats | myGlobal.SendRealmSummaryStats (true); | If true sends the realms status summary updates (true/false) |
Audit Settings | ||
RealmMaintenance | myAudit.RealmMaintenance (false); | Log to the audit file any realm maintenance activity |
InterfaceManagement | myAudit.InterfaceManagement (false); | Log to the audit file any interface management activity |
ChannelMaintenance | myAudit.ChannelMaintenance (false); | Log to the audit file any channel maintenance activity |
QueueMaintenance | myAudit.QueueMaintenance (false); | Log to the audit file any queue maintenance activity |
ServiceMaintenance | myAudit.ServiceMaintenance (false); | Log to the audit file any service maintenance activity |
JoinMaintenance | myAudit.JoinMaintenance(false); | Log to the audit file any join maintenance activity |
RealmSuccess | myAudit.RealmSuccess(false); | Log to the audit file any successful realm interactions |
ChannelSuccess | myAudit.ChannelSuccess(false); | Log to the audit file any successful channel interactions |
QueueSuccess | myAudit.QueueSuccess(false); | Log to the audit file any successful queue interactions |
ServiceSuccess | myAudit.ServiceSuccess(false); | Log to the audit file any successful realm interactions |
JoinSuccess | myAudit.JoinSuccess(false); | Log to the audit file any successful join interactions |
RealmFailure | myAudit.RealmFailure(false); | Log to the audit file any unsuccessful realm interactions |
ChannelFailure | myAudit.ChannelFailure(false); | Log to the audit file any unsuccessful channel interactions |
QueueFailure | myAudit.QueueFailure(false); | Log to the audit file any unsuccessful queue interactions |
ServiceFailure | myAudit.ServiceFailure(false); | Log to the audit file any unsuccessful service interactions |
JoinFailure | myAudit.JoinFailure(false); | Log to the audit file any unsuccessful join interactions |
RealmACL | myAudit.RealmACL(false); | Log to the audit file any unsuccessful realm acl interactions |
ChannelACL | myAudit.ChannelACL(false); | Log to the audit file any unsuccessful channel acl interactions |
QueueACL | myAudit.QueueACL(false); | Log to the audit file any unsuccessful queue acl interactions |
ServiceACL | myAudit.ServiceACL(false); | Log to the audit file any unsuccessful service acl interactions |
Client Timeout Values | ||
EventTimeout | myClientTimeout.EventTimeout (10000); | The amount of ms the client will wait for a response from the server |
DisconnectWait | myClientTimeout.DisconnectWait (30000); | The maximum amount of time to wait when performing an operation when disconnected before throwing session not connected exception |
TransactionLifeTime | myClientTimeout.TransactionLifeTime (10000); | The default amount of time a transaction is valid before being removed from the tx store |
KaWait | myClientTimeout.KaWait(10000); | The amount of time the client will wait for keep alive interactions between server before acknowledging disconnected state |
LowWaterMark | myClientTimeout.LowWaterMark (200); | The low water mark for the connection internal queue. When this value is reached the outbound internal queue will again be ready to push event to the server |
HighWaterMark | myClientTimeout.HighWaterMark (500); | The high water mark for the connection internal queue. When this value is reached the internal queue is temporarily suspended and unable to send events to the server. This provides flow control between publisher and server. |
QueueBlockLimit | myClientTimeout.QueueBlockLimit (5000); | The maximum number of milliseconds a queue will have reached HWM before notifying listeners |
QueueAccessWaitLimit | myClientTimeout.QueueAccessWaitLimit (10000); | The maximum number of milliseconds it should take to gain access to a queue to push events before notifying listeners |
QueuePushWaitLimit | myClientTimeout.QueuePushWaitLimit (12000); | The maximum number of milliseconds it should take to gain access to a queue and to push events before notifying listeners |
Cluster Config | ||
HeartBeatInterval | myCluster.HeartBeatInterval (60000); | Heart Beat interval in milliseconds |
EventsOutStanding | myCluster.EventsOutStanding (10); | Number of events outstanding |
Event Storage | ||
CacheAge | myEventStorage.CacheAge(360000); | The time in ms that cached events will be kept in memory for |
ThreadPoolSize | myEventStorage.ThreadPoolSize(2); | The number of threads allocated to perform the management task on the channels |
ActiveDelay | myEventStorage.ActiveDelay(1000); | The time in milliseconds that an active channel will delay between scans |
IdleDelay | myEventStorage.IdleDelay(60000); | The time in milliseconds that an idle channel will delay between scans |
Fanout Values | ||
ConcurrentUser | myFanout.ConcurrentUser(5); | The number of client threads allowed to execute concurrently in the server |
KeepAlive | myFanout.KeepAlive(60000); | The number of milliseconds between the server will wait before sending a heartbeat |
QueueHighWaterMark | myFanout.QueueHighWaterMark(500); | The number of events in a client output queue before the server stops sending events |
QueueLowWaterMark | myFanout.QueueLowWaterMark(200); | The number of events in the clients queue before the server resumes sending events |
MaxBufferSize | myFanout.MaxBufferSize(1024000); | The maximum buffer size that the server will accept |
PublishDelay | myFanout.PublishDelay(100); | How long to delay the publisher when subscribers queue start to fill, in milliseconds |
PublishExpiredEvents | myFanout.PublishExpiredEvents(true); | Publish expired events at server startup (true/false) |
Join Config | ||
MaxEventsPerSchedule | myJoinConfig.MaxEventsPerSchedule (200); | Number of events that will be sent to the remote server in one run |
MaxQueueSizeToUse | myJoinConfig.MaxQueueSizeToUse (50); | The maximum events that will be queued on behalf of the remote server |
ActiveThreadPoolSize | myJoinConfig.ActiveThreadPoolSize (4); | The number of threads to be assigned for the join recovery |
IdleThreadPoolSize | myJoinConfig.IdleThreadPoolSize (2); | The number of threads to manage the idle and reconnection to remote servers |
Logging Config | ||
fLoggerLevel | myLoggingConfig.fLoggerLevel(4); | The server logging level |
RecoveryDaemon | ||
ThreadPool | myRecovery.ThreadPool(5); | Number of threads to use for client recovery |
EventsPerBlock | myRecovery.EventsPerBlock(300); | The number of events to send in one block |
TransactionManager | ||
MaxTransactionTime | myTXMgr.MaxTransactionTime (1000); | Time in milliseconds that a transaction will be kept active |
MaxEventsPerTransaction | myTXMgr.MaxEventsPerTransaction (1000); | The maximum number of events per transaction, a 0 indicates no limit |
TTLThreshold | myTXMgr.TTLThreshold(1000); | The minimum time in milliseconds, below which the server will not store the Transaction ID |