HBLEvents

Instance Constructors

new HBLEvents(client: HBClient, config: StorageClientConfig, namespace: String)

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val client: HBClient
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def close(): Unit

:: DeveloperApi :: Close this Event Store interface object, e.
:: DeveloperApi :: Close this Event Store interface object, e.g. close connection, release resources, etc.

Definition Classes
HBLEvents → LEvents
def debug(msg: ⇒ Any, t: ⇒ Throwable): Unit

Attributes
protected
Definition Classes
Logging
def debug(msg: ⇒ Any): Unit

Attributes
protected
Definition Classes
Logging
val defaultTimeout: FiniteDuration

Default timeout for asynchronous operations that is set to 1 minute
Default timeout for asynchronous operations that is set to 1 minute

Definition Classes
LEvents
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def error(msg: ⇒ Any, t: ⇒ Throwable): Unit

Attributes
protected
Definition Classes
Logging
def error(msg: ⇒ Any): Unit

Attributes
protected
Definition Classes
Logging
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def futureDelete(eventId: String, appId: Int, channelId: Option[Int])(implicit ec: ExecutionContext): Future[Boolean]

:: DeveloperApi :: Delete an Event in a non-blocking fashion.
:: DeveloperApi :: Delete an Event in a non-blocking fashion.
eventId
ID of the Event
appId
ID of the app that contains the Event
channelId
Optional channel ID that contains the Event

Definition Classes
HBLEvents → LEvents
def futureDelete(eventId: String, appId: Int)(implicit ec: ExecutionContext): Future[Boolean]

:: DeveloperApi :: Delete an Event in a non-blocking fashion.
:: DeveloperApi :: Delete an Event in a non-blocking fashion.
eventId
ID of the Event
appId
ID of the app that contains the Event

Definition Classes
LEvents
Annotations
@DeveloperApi()
def futureFind(appId: Int, channelId: Option[Int] = None, startTime: Option[DateTime] = None, untilTime: Option[DateTime] = None, entityType: Option[String] = None, entityId: Option[String] = None, eventNames: Option[Seq[String]] = None, targetEntityType: Option[Option[String]] = None, targetEntityId: Option[Option[String]] = None, limit: Option[Int] = None, reversed: Option[Boolean] = None)(implicit ec: ExecutionContext): Future[Iterator[Event]]

:: DeveloperApi :: Reads from database and returns a Future of Iterator of Events.
:: DeveloperApi :: Reads from database and returns a Future of Iterator of Events.
appId
return events of this app ID
channelId
return events of this channel ID (default channel if it's None)
startTime
return events with eventTime >= startTime
untilTime
return events with eventTime < untilTime
entityType
return events of this entityType
entityId
return events of this entityId
eventNames
return events with any of these event names.
targetEntityType
return events of this targetEntityType:
- None means no restriction on targetEntityType
- Some(None) means no targetEntityType for this event
- Some(Some(x)) means targetEntityType should match x.
targetEntityId
return events of this targetEntityId
- None means no restriction on targetEntityId
- Some(None) means no targetEntityId for this event
- Some(Some(x)) means targetEntityId should match x.
limit
Limit number of events. Get all events if None or Some(-1)
reversed
Reverse the order.
- return oldest events first if None or Some(false) (default)
- return latest events first if Some(true)
ec
ExecutionContext
returns
Future[Iterator[Event]]
Definition Classes
HBLEvents → LEvents
def futureGet(eventId: String, appId: Int, channelId: Option[Int])(implicit ec: ExecutionContext): Future[Option[Event]]

:: DeveloperApi :: Get an Event in a non-blocking fashion.
:: DeveloperApi :: Get an Event in a non-blocking fashion.
eventId
ID of the Event
appId
ID of the app that contains the Event
channelId
Optional channel ID that contains the Event

Definition Classes
HBLEvents → LEvents
def futureGet(eventId: String, appId: Int)(implicit ec: ExecutionContext): Future[Option[Event]]

:: DeveloperApi :: Get an Event in a non-blocking fashion.
:: DeveloperApi :: Get an Event in a non-blocking fashion.
eventId
ID of the Event
appId
ID of the app that contains the Event

Definition Classes
LEvents
Annotations
@DeveloperApi()
def futureInsert(event: Event, appId: Int, channelId: Option[Int])(implicit ec: ExecutionContext): Future[String]

:: DeveloperApi :: Insert an Event in a non-blocking fashion.
:: DeveloperApi :: Insert an Event in a non-blocking fashion.
event
An Event to be inserted
appId
App ID for the Event to be inserted to
channelId
Optional channel ID for the Event to be inserted to

Definition Classes
HBLEvents → LEvents
def futureInsert(event: Event, appId: Int)(implicit ec: ExecutionContext): Future[String]

:: DeveloperApi :: Insert an Event in a non-blocking fashion.
:: DeveloperApi :: Insert an Event in a non-blocking fashion.
event
An Event to be inserted
appId
App ID for the Event to be inserted to

Definition Classes
LEvents
Annotations
@DeveloperApi()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getTable(appId: Int, channelId: Option[Int] = None): HTableInterface
def hashCode(): Int

Definition Classes
AnyRef → Any
def info(msg: ⇒ Any, t: ⇒ Throwable): Unit

Attributes
protected
Definition Classes
Logging
def info(msg: ⇒ Any): Unit

Attributes
protected
Definition Classes
Logging
def init(appId: Int, channelId: Option[Int] = None): Boolean

:: DeveloperApi :: Initialize Event Store for an app ID and optionally a channel ID.
:: DeveloperApi :: Initialize Event Store for an app ID and optionally a channel ID. This routine is to be called when an app is first created.
appId
App ID
channelId
Optional channel ID
returns
true if initialization was successful; false otherwise.

Definition Classes
HBLEvents → LEvents
def isDebugEnabled: Boolean

Attributes
protected
Definition Classes
Logging
def isErrorEnabled: Boolean

Attributes
protected
Definition Classes
Logging
def isInfoEnabled: Boolean

Attributes
protected
Definition Classes
Logging
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isTraceEnabled: Boolean

Attributes
protected
Definition Classes
Logging
def isWarnEnabled: Boolean

Attributes
protected
Definition Classes
Logging
def logger: Logger

Attributes
protected
Definition Classes
Logging
def loggerName: String

Attributes
protected
Definition Classes
Logging
val namespace: String
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def remove(appId: Int, channelId: Option[Int] = None): Boolean

:: DeveloperApi :: Remove Event Store for an app ID and optional channel ID.
:: DeveloperApi :: Remove Event Store for an app ID and optional channel ID.
appId
App ID
channelId
Optional channel ID
returns
true if removal was successful; false otherwise.

Definition Classes
HBLEvents → LEvents
def resultToEvent(result: Result, appId: Int): Event
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def trace(msg: ⇒ Any, t: ⇒ Throwable): Unit

Attributes
protected
Definition Classes
Logging
def trace(msg: ⇒ Any): Unit

Attributes
protected
Definition Classes
Logging
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def warn(msg: ⇒ Any, t: ⇒ Throwable): Unit

Attributes
protected
Definition Classes
Logging
def warn(msg: ⇒ Any): Unit

Attributes
protected
Definition Classes
Logging

Deprecated Value Members

def findSingleEntity(appId: Int, channelId: Option[Int] = None, entityType: String, entityId: String, eventNames: Option[Seq[String]] = None, targetEntityType: Option[Option[String]] = None, targetEntityId: Option[Option[String]] = None, startTime: Option[DateTime] = None, untilTime: Option[DateTime] = None, limit: Option[Int] = None, latest: Boolean = true, timeout: Duration = defaultTimeout)(implicit ec: ExecutionContext): Either[StorageError, Iterator[Event]]

reads events of the specified entity.
reads events of the specified entity.
appId
return events of this app ID
channelId
return events of this channel ID (default channel if it's None)
entityType
return events of this entityType
entityId
return events of this entityId
eventNames
return events with any of these event names.
targetEntityType
return events of this targetEntityType:
- None means no restriction on targetEntityType
- Some(None) means no targetEntityType for this event
- Some(Some(x)) means targetEntityType should match x.
targetEntityId
return events of this targetEntityId
- None means no restriction on targetEntityId
- Some(None) means no targetEntityId for this event
- Some(Some(x)) means targetEntityId should match x.
startTime
return events with eventTime >= startTime
untilTime
return events with eventTime < untilTime
limit
Limit number of events. Get all events if None or Some(-1)
latest
Return latest event first (default true)
ec
ExecutionContext
returns
Either[StorageError, Iterator[Event]]
Definition Classes
LEvents
Annotations
@deprecated
Deprecated
(Since version 0.9.2) Use LEventStore.findByEntity() instead.

class HBLEvents extends LEvents with Logging

Instance Constructors

new HBLEvents(client: HBClient, config: StorageClientConfig, namespace: String)

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val client: HBClient

def clone(): AnyRef

def close(): Unit

def debug(msg: ⇒ Any, t: ⇒ Throwable): Unit

def debug(msg: ⇒ Any): Unit

val defaultTimeout: FiniteDuration

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def error(msg: ⇒ Any, t: ⇒ Throwable): Unit

def error(msg: ⇒ Any): Unit

def finalize(): Unit

def futureDelete(eventId: String, appId: Int, channelId: Option[Int])(implicit ec: ExecutionContext): Future[Boolean]

def futureDelete(eventId: String, appId: Int)(implicit ec: ExecutionContext): Future[Boolean]

def futureGet(eventId: String, appId: Int, channelId: Option[Int])(implicit ec: ExecutionContext): Future[Option[Event]]

def futureGet(eventId: String, appId: Int)(implicit ec: ExecutionContext): Future[Option[Event]]

def futureInsert(event: Event, appId: Int, channelId: Option[Int])(implicit ec: ExecutionContext): Future[String]

def futureInsert(event: Event, appId: Int)(implicit ec: ExecutionContext): Future[String]

final def getClass(): Class[_]

def getTable(appId: Int, channelId: Option[Int] = None): HTableInterface

def hashCode(): Int

def info(msg: ⇒ Any, t: ⇒ Throwable): Unit

def info(msg: ⇒ Any): Unit

def init(appId: Int, channelId: Option[Int] = None): Boolean

def isDebugEnabled: Boolean

def isErrorEnabled: Boolean

def isInfoEnabled: Boolean

final def isInstanceOf[T0]: Boolean

def isTraceEnabled: Boolean

def isWarnEnabled: Boolean

def logger: Logger

def loggerName: String

val namespace: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def remove(appId: Int, channelId: Option[Int] = None): Boolean

def resultToEvent(result: Result, appId: Int): Event

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def trace(msg: ⇒ Any, t: ⇒ Throwable): Unit

def trace(msg: ⇒ Any): Unit

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def warn(msg: ⇒ Any, t: ⇒ Throwable): Unit

def warn(msg: ⇒ Any): Unit

Deprecated Value Members

Inherited from Logging

Inherited from LEvents

Inherited from AnyRef

Inherited from Any

Ungrouped