SharedObjectpublic interface ISharedObject
ISharedObject: public interface to SharedObject class.
| Modifier and Type | Field | Description |
|---|---|---|
static String |
FILEEXTENSION |
|
static byte |
SHAREDOBJECT_CMD_CONNECT |
shared object command: connect
|
static byte |
SHAREDOBJECT_CMD_CONNECTSUCCESS |
shared object command: clear
|
static byte |
SHAREDOBJECT_CMD_DELETE |
shared object command: delete
|
static byte |
SHAREDOBJECT_CMD_DISCONNECT |
shared object command: disconnect
|
static byte |
SHAREDOBJECT_CMD_ERROR |
shared object command: error
|
static byte |
SHAREDOBJECT_CMD_SEND |
shared object command: send
|
static byte |
SHAREDOBJECT_CMD_SETVALUE |
shared object command: setvalue
|
static byte |
SHAREDOBJECT_STATUS_CHANGE |
shared object status: change
|
static byte |
SHAREDOBJECT_STATUS_CLEAR |
shared object status: clear
|
static byte |
SHAREDOBJECT_STATUS_DELETE |
shared object status: delete
|
static byte |
SHAREDOBJECT_STATUS_SUCCESS |
shared object status: success
|
| Modifier and Type | Method | Description |
|---|---|---|
void |
acquire() |
Increment the reference count to this shared object.
|
void |
addClient(IClient client) |
Add a client to this shared object.
|
void |
addSlotListener(ISharedObjectSlotNotify slotListener) |
Add a slot listener.
|
void |
clear() |
Clear all properties from a shared object
|
void |
close() |
Force close this shared object (not implemented)
|
boolean |
containsProperty(String slotName) |
Returns true is slot/property name exists
|
boolean |
containsSlot(String slotName) |
Returns true is slot/property name exists
|
void |
deleteSlot(IClient client,
String slotName) |
Remove a slot (property)
|
void |
deleteSlot(String slotName) |
Remove slot (property)
|
void |
disconnect(IClient client) |
Disconnect client from shared object.
|
void |
flush() |
Flush (write to disk) shared object
|
java.util.List<com.wowza.wms.sharedobject.SharedObjectClient> |
getClients() |
Get a list of client that are connected to this shared object.
|
String |
getName() |
Get shared object name
|
ISharedObjects |
getParent() |
Get the shared object container to which this shared object belongs.
|
AMFData |
getProperty(String slotName) |
Get slot (property) value.
|
int |
getRefCount() |
Get the current reference (clients) connected to this shared object.
|
ISharedObjectSlot |
getSlot(String name) |
Get ISharedObjectSlot interface to a slot (property) by name
|
java.util.List<String> |
getSlotNames() |
Get a list of slot (property) names
|
java.util.List<ISharedObjectSlot> |
getSlots() |
Get a list of active slots
|
String |
getStorageDir() |
Get path used to store shared object.
|
int |
getVersion() |
Get the internval version number.
|
boolean |
isClient(IClient client) |
Is this client connected to shared object
|
boolean |
isPersistent() |
Is this shared object being persisted.
|
void |
lock() |
Lock a shared object for write access
|
int |
purge(int version) |
Purge all deleted properties older than the version number
|
void |
putSlot(String name,
ISharedObjectSlot slot) |
Add a new slot (property) to a shared object.
|
void |
release() |
Descrement the reference count to this shared object.
|
void |
removeClient(IClient client) |
Remove a client from this shared object.
|
void |
removeSlotListener(ISharedObjectSlotNotify slotListener) |
Remove slot listener
|
void |
send(String handlerName) |
Call client side handler attached to shared object (no parameters).
|
void |
send(String handlerName,
Object... params) |
Call client side handler attached to shared object.
|
void |
setName(String name) |
Set shared object name
|
void |
setPersistent(boolean isPersistent) |
Set is shared object persisted.
|
void |
setProperty(String slotName,
boolean value) |
Set slot (property) value as a boolean value (will be wrapped in an AMFDataItem object)
|
void |
setProperty(String slotName,
double value) |
Set slot (property) value as a double value (will be wrapped in an AMFDataItem object)
|
void |
setProperty(String slotName,
int value) |
Set slot (property) value as a int value (will be wrapped in an AMFDataItem object)
|
void |
setProperty(String slotName,
long value) |
Set slot (property) value as a long value (will be wrapped in an AMFDataItem object)
|
void |
setProperty(String slotName,
AMFData data) |
Set slot (property) value as AMFData object.
|
void |
setProperty(String slotName,
String value) |
Set slot (property) value as a string value (will be wrapped in an AMFDataItem object)
|
void |
setProperty(String slotName,
java.util.Date value) |
Set slot (property) value as a date value (will be wrapped in an AMFDataItem object)
|
void |
setStorageDir(String storageDir) |
Set path used to store shared object.
|
void |
setVersion(int version) |
Set the internal version number.
|
int |
size() |
Get the number of active slot (properties).
|
void |
unlock() |
Unlock a shared object for write access
|
void |
writeDeleteError(IClient client,
String soName,
boolean isPersistent,
String slotName,
String errorMsg) |
Write an delete error message back to the client
|
void |
writeSetValueError(IClient client,
String soName,
boolean isPersistent,
String slotName,
String errorMsg) |
Write an set value error message back to the client
|
static final String FILEEXTENSION
static final byte SHAREDOBJECT_CMD_CONNECT
static final byte SHAREDOBJECT_CMD_CONNECTSUCCESS
static final byte SHAREDOBJECT_CMD_DELETE
static final byte SHAREDOBJECT_CMD_DISCONNECT
static final byte SHAREDOBJECT_CMD_ERROR
static final byte SHAREDOBJECT_CMD_SEND
static final byte SHAREDOBJECT_CMD_SETVALUE
static final byte SHAREDOBJECT_STATUS_CHANGE
static final byte SHAREDOBJECT_STATUS_CLEAR
static final byte SHAREDOBJECT_STATUS_DELETE
static final byte SHAREDOBJECT_STATUS_SUCCESS
void acquire()
void addClient(IClient client)
client - clientvoid addSlotListener(ISharedObjectSlotNotify slotListener)
slotListener - slot listenervoid clear()
void close()
boolean containsProperty(String slotName)
slotName - slot/property nameboolean containsSlot(String slotName)
slotName - slot/property namevoid deleteSlot(IClient client, String slotName)
client - client removing slot or null if server side codeslotName - slot (property) namevoid deleteSlot(String slotName)
slotName - slot (property) namevoid disconnect(IClient client)
client - client to disconnectvoid flush()
java.util.List<com.wowza.wms.sharedobject.SharedObjectClient> getClients()
String getName()
ISharedObjects getParent()
AMFData getProperty(String slotName)
slotName - slot (property) nameint getRefCount()
ISharedObjectSlot getSlot(String name)
name - slot (property) namejava.util.List<String> getSlotNames()
java.util.List<ISharedObjectSlot> getSlots()
String getStorageDir()
int getVersion()
boolean isClient(IClient client)
client - clientboolean isPersistent()
void lock()
int purge(int version)
void putSlot(String name,
ISharedObjectSlot slot)
name - slot (property) nameslot - new slotvoid release()
void removeClient(IClient client)
client - clientvoid removeSlotListener(ISharedObjectSlotNotify slotListener)
slotListener - slot listenervoid send(String handlerName)
handlerName - handler namevoid send(String handlerName,
Object... params)
handlerName - handler nameparams - variable argument list of parametersvoid setName(String name)
name - shared object namevoid setPersistent(boolean isPersistent)
isPersistent - true if shared object is being persistedvoid setProperty(String slotName,
boolean value)
slotName - slot (property) namevalue - boolean valuevoid setProperty(String slotName,
double value)
slotName - slot (property) namevalue - double valuevoid setProperty(String slotName,
int value)
slotName - slot (property) namevalue - int valuevoid setProperty(String slotName,
long value)
slotName - slot (property) namevalue - long valuevoid setProperty(String slotName,
AMFData data)
slotName - slot (property) namedata - slot value as AMFData object. Example: new AMFDataItem((double)1.234) or new AMFDataItem()void setProperty(String slotName,
String value)
slotName - slot (property) namevalue - string valuevoid setProperty(String slotName,
java.util.Date value)
slotName - slot (property) namevalue - date valuevoid setStorageDir(String storageDir)
storageDir - path used to store shared objectvoid setVersion(int version)
version - internal version numberint size()
void unlock()
void writeDeleteError(IClient client, String soName, boolean isPersistent, String slotName, String errorMsg)
client - client removing slot or null if server side codesoName - sharedObject nameisPersistent - is persistentslotName - slot nameerrorMsg - error messagevoid writeSetValueError(IClient client, String soName, boolean isPersistent, String slotName, String errorMsg)
client - client removing slot or null if server side codesoName - sharedObject nameisPersistent - is persistentslotName - slot nameerrorMsg - error message