[Red5commits] [1597] Stream package 95% documentedSome messaging documentationMinor code style impr
mklishin
luke at codegent.com
Wed Jan 24 11:03:02 EST 2007
Stream package 95% documented
Some messaging documentation
Minor code style improvement
Timestamp: 12/22/06 18:26:10 EST (1 month ago)
Change: 1597
Author: mklishin
Files (see diff or trac for details):
java/server/trunk/src/org/red5/server/WebScope.java
java/server/trunk/src/org/red5/server/adapter/AbstractScopeAdapter.java
java/server/trunk/src/org/red5/server/adapter/StatefulScopeWrappingAdapter.java
java/server/trunk/src/org/red5/server/api/IBandwidthConfigure.java
java/server/trunk/src/org/red5/server/api/IContext.java
java/server/trunk/src/org/red5/server/api/IFlowControllable.java
java/server/trunk/src/org/red5/server/api/Red5.java
java/server/trunk/src/org/red5/server/api/event/IEventObservable.java
java/server/trunk/src/org/red5/server/api/service/IPendingServiceCall.java
java/server/trunk/src/org/red5/server/api/stream/IPlaylist.java
java/server/trunk/src/org/red5/server/api/stream/ISingleItemSubscriberStream.java
java/server/trunk/src/org/red5/server/api/stream/IStreamCodecInfo.java
java/server/trunk/src/org/red5/server/api/stream/IStreamFilenameGenerator.java
java/server/trunk/src/org/red5/server/api/stream/IStreamService.java
java/server/trunk/src/org/red5/server/api/stream/ResourceExistException.java
java/server/trunk/src/org/red5/server/api/stream/ResourceNotFoundException.java
java/server/trunk/src/org/red5/server/api/stream/support/SimplePlayItem.java
java/server/trunk/src/org/red5/server/cache/CacheImpl.java
java/server/trunk/src/org/red5/server/cache/CacheableImpl.java
java/server/trunk/src/org/red5/server/cache/EhCacheImpl.java
java/server/trunk/src/org/red5/server/cache/NoCacheImpl.java
java/server/trunk/src/org/red5/server/cache/WhirlyCacheImpl.java
java/server/trunk/src/org/red5/server/exception/ClientRejectedException.java
java/server/trunk/src/org/red5/server/jetty/Red5WebPropertiesConfiguration.java
java/server/trunk/src/org/red5/server/midi/SharedMidiObject.java
java/server/trunk/src/org/red5/server/midi/Test.java
java/server/trunk/src/org/red5/server/net/protocol/ProtocolException.java
java/server/trunk/src/org/red5/server/net/protocol/SimpleProtocolCodecFactory.java
java/server/trunk/src/org/red5/server/net/proxy/DebugProxyHandler.java
java/server/trunk/src/org/red5/server/net/proxy/NetworkDumpFilter.java
java/server/trunk/src/org/red5/server/net/proxy/ProxyFilter.java
java/server/trunk/src/org/red5/server/net/remoting/RemotingClient.java
java/server/trunk/src/org/red5/server/net/remoting/codec/RemotingCodecFactory.java
java/server/trunk/src/org/red5/server/net/remoting/codec/RemotingProtocolDecoder.java
java/server/trunk/src/org/red5/server/net/remoting/codec/RemotingProtocolEncoder.java
java/server/trunk/src/org/red5/server/net/remoting/message/RemotingCall.java
java/server/trunk/src/org/red5/server/net/remoting/message/RemotingPacket.java
java/server/trunk/src/org/red5/server/net/rtmp/BaseRTMPHandler.java
java/server/trunk/src/org/red5/server/net/rtmp/Channel.java
java/server/trunk/src/org/red5/server/net/rtmp/DeferredResult.java
java/server/trunk/src/org/red5/server/net/rtmp/RTMPClient.java
java/server/trunk/src/org/red5/server/net/rtmp/RTMPConnection.java
java/server/trunk/src/org/red5/server/net/rtmp/RTMPHandler.java
java/server/trunk/src/org/red5/server/net/rtmp/RTMPMinaConnection.java
java/server/trunk/src/org/red5/server/net/rtmp/RTMPMinaIoHandler.java
java/server/trunk/src/org/red5/server/net/rtmp/codec/MulticastEventProcessor.java
java/server/trunk/src/org/red5/server/net/rtmp/codec/RTMP.java
java/server/trunk/src/org/red5/server/net/rtmp/codec/RTMPCodecFactory.java
java/server/trunk/src/org/red5/server/net/rtmp/codec/RTMPMinaCodecFactory.java
java/server/trunk/src/org/red5/server/net/rtmp/codec/RTMPMinaProtocolDecoder.java
java/server/trunk/src/org/red5/server/net/rtmp/codec/RTMPMinaProtocolEncoder.java
java/server/trunk/src/org/red5/server/net/rtmp/codec/RTMPProtocolDecoder.java
java/server/trunk/src/org/red5/server/net/rtmp/codec/RTMPProtocolEncoder.java
java/server/trunk/src/org/red5/server/net/rtmp/event/AllocationDebugger.java
java/server/trunk/src/org/red5/server/net/rtmp/event/AudioData.java
java/server/trunk/src/org/red5/server/net/rtmp/event/BaseEvent.java
java/server/trunk/src/org/red5/server/net/rtmp/event/BytesRead.java
java/server/trunk/src/org/red5/server/net/rtmp/event/ChunkSize.java
java/server/trunk/src/org/red5/server/net/rtmp/event/ClientBW.java
java/server/trunk/src/org/red5/server/net/rtmp/event/FLVData.java
java/server/trunk/src/org/red5/server/net/rtmp/event/IRTMPEvent.java
java/server/trunk/src/org/red5/server/net/rtmp/event/Invoke.java
java/server/trunk/src/org/red5/server/net/rtmp/event/Notify.java
java/server/trunk/src/org/red5/server/net/rtmp/event/Ping.java
java/server/trunk/src/org/red5/server/net/rtmp/event/ServerBW.java
java/server/trunk/src/org/red5/server/net/rtmp/event/Unknown.java
java/server/trunk/src/org/red5/server/net/rtmp/event/VideoData.java
java/server/trunk/src/org/red5/server/net/rtmp/message/Header.java
java/server/trunk/src/org/red5/server/net/rtmp/message/Packet.java
java/server/trunk/src/org/red5/server/net/rtmp/status/RuntimeStatusObject.java
java/server/trunk/src/org/red5/server/net/rtmp/status/Status.java
java/server/trunk/src/org/red5/server/net/rtmp/status/StatusObject.java
java/server/trunk/src/org/red5/server/net/rtmp/status/StatusObjectService.java
java/server/trunk/src/org/red5/server/net/rtmpt/RTMPTConnection.java
java/server/trunk/src/org/red5/server/net/rtmpt/RTMPTHandler.java
java/server/trunk/src/org/red5/server/net/rtmpt/RTMPTLoader.java
java/server/trunk/src/org/red5/server/net/rtmpt/RTMPTServlet.java
java/server/trunk/src/org/red5/server/net/rtmpt/TomcatRTMPTLoader.java
java/server/trunk/src/org/red5/server/net/rtmpt/codec/RTMPTCodecFactory.java
java/server/trunk/src/org/red5/server/net/servlet/AMFGatewayServlet.java
java/server/trunk/src/org/red5/server/net/servlet/CaptureViewerServlet.java
java/server/trunk/src/org/red5/server/net/servlet/RequestDumpServlet.java
java/server/trunk/src/org/red5/server/net/servlet/ServletConnection.java
java/server/trunk/src/org/red5/server/net/servlet/StatisticsServlet.java
java/server/trunk/src/org/red5/server/net/servlet/ZAMFGatewayServlet.java
java/server/trunk/src/org/red5/server/persistence/FilePersistence.java
java/server/trunk/src/org/red5/server/persistence/RamPersistence.java
java/server/trunk/src/org/red5/server/pooling/ThreadObjectFactory.java
java/server/trunk/src/org/red5/server/pooling/ThreadPool.java
java/server/trunk/src/org/red5/server/pooling/WorkerThread.java
java/server/trunk/src/org/red5/server/scheduling/QuartzSchedulingService.java
java/server/trunk/src/org/red5/server/scheduling/QuartzSchedulingServiceJob.java
java/server/trunk/src/org/red5/server/service/Call.java
java/server/trunk/src/org/red5/server/service/ContextServiceResolver.java
java/server/trunk/src/org/red5/server/service/HandlerServiceResolver.java
java/server/trunk/src/org/red5/server/service/PendingCall.java
java/server/trunk/src/org/red5/server/service/ScopeServiceResolver.java
java/server/trunk/src/org/red5/server/service/ServiceInvoker.java
java/server/trunk/src/org/red5/server/service/ServiceUtils.java
java/server/trunk/src/org/red5/server/so/ClientSharedObject.java
java/server/trunk/src/org/red5/server/so/ISharedObjectMessage.java
java/server/trunk/src/org/red5/server/so/SharedObject.java
java/server/trunk/src/org/red5/server/so/SharedObjectEvent.java
java/server/trunk/src/org/red5/server/so/SharedObjectMessage.java
java/server/trunk/src/org/red5/server/so/SharedObjectScope.java
java/server/trunk/src/org/red5/server/so/SharedObjectService.java
java/server/trunk/src/org/red5/server/statistics/ScopeStatistics.java
Trac: http://mirror1.cvsdude.com/trac/osflash/red5/changeset/1597
Index: /java/server/trunk/src/org/red5/server/adapter/StatefulScopeWrappingAdapter.java
===================================================================
--- /java/server/trunk/src/org/red5/server/adapter/StatefulScopeWrappingAdapter.java (revision 1587)
+++ /java/server/trunk/src/org/red5/server/adapter/StatefulScopeWrappingAdapter.java (revision 1597)
@@ -44,97 +44,175 @@
protected IScope scope;
- public void setScope(IScope scope) {
+ /** {@inheritDoc} */
+ public void setScope(IScope scope) {
this.scope = scope;
}
- public IScope getScope() {
+ /**
+ * Getter for property 'scope'.
+ *
+ * @return Value for property 'scope'.
+ */
+ public IScope getScope() {
return scope;
}
- public Object getAttribute(String name) {
+ /** {@inheritDoc} */
+ public Object getAttribute(String name) {
return scope.getAttribute(name);
}
- public Object getAttribute(String name, Object defaultValue) {
+ /** {@inheritDoc} */
+ public Object getAttribute(String name, Object defaultValue) {
return scope.getAttribute(name, defaultValue);
}
- public Set<String> getAttributeNames() {
+ /** {@inheritDoc} */
+ public Set<String> getAttributeNames() {
return scope.getAttributeNames();
}
- public Map<String, Object> getAttributes() {
- return scope.getAttributes();
- }
-
- public boolean hasAttribute(String name) {
+ /**
+ * Wrapper for Scope#getAttributes
+ * @return Scope attributes map
+ */
+ public Map<String, Object> getAttributes() {
+ return scope.getAttributes();
+ }
+
+ /** {@inheritDoc} */
+ public boolean hasAttribute(String name) {
return scope.hasAttribute(name);
}
- public boolean removeAttribute(String name) {
+ /** {@inheritDoc} */
+ public boolean removeAttribute(String name) {
return scope.removeAttribute(name);
}
- public void removeAttributes() {
+ /** {@inheritDoc} */
+ public void removeAttributes() {
scope.removeAttributes();
}
- public boolean setAttribute(String name, Object value) {
+ /** {@inheritDoc} */
+ public boolean setAttribute(String name, Object value) {
return scope.setAttribute(name, value);
}
- public void setAttributes(IAttributeStore values) {
+ /** {@inheritDoc} */
+ public void setAttributes(IAttributeStore values) {
scope.setAttributes(values);
}
- public void setAttributes(Map<String, Object> values) {
+ /** {@inheritDoc} */
+ public void setAttributes(Map<String, Object> values) {
scope.setAttributes(values);
}
- public boolean createChildScope(String name) {
+ /**
+ * Creates child scope
+ * @param name Child scope name
+ * @return <code>true</code> on success, <code>false</code> otherwise
+ */
+ public boolean createChildScope(String name) {
return scope.createChildScope(name);
}
- public IScope getChildScope(String name) {
+ /**
+ * Return child scope
+ * @param name Child scope name
+ * @return Child scope with given name
+ */
+ public IScope getChildScope(String name) {
return scope.getScope(name);
}
- public Iterator<String> getChildScopeNames() {
+ /**
+ * Iterator for child scope names
+ *
+ * @return Iterator for child scope names
+ */
+ public Iterator<String> getChildScopeNames() {
return scope.getScopeNames();
}
- public Set<IClient> getClients() {
+ /**
+ * Getter for set of clients
+ *
+ * @return Set of clients
+ */
+ public Set<IClient> getClients() {
return scope.getClients();
}
- public Iterator<IConnection> getConnections() {
+ /**
+ * Return for connections iterator
+ *
+ * @return Connections
+ */
+ public Iterator<IConnection> getConnections() {
return scope.getConnections();
}
- public IContext getContext() {
+ /**
+ * Getter for context
+ *
+ * @return Value for context
+ */
+ public IContext getContext() {
return scope.getContext();
}
- public int getDepth() {
+ /**
+ * Getter for depth
+ *
+ * @return Value for depth
+ */
+ public int getDepth() {
return scope.getDepth();
}
- public String getName() {
+ /**
+ * Getter for name
+ *
+ * @return Value for name
+ */
+ public String getName() {
return scope.getName();
}
- public IScope getParent() {
+ /**
+ * Return parent scope
+ *
+ * @return Parent scope
+ */
+ public IScope getParent() {
return scope.getParent();
}
- public String getPath() {
+ /**
+ * Getter for stateful scope path
+ *
+ * @return Value for path
+ */
+ public String getPath() {
return scope.getPath();
}
- public boolean hasChildScope(String name) {
+ /**
+ * Whether this scope has a child scope with given name
+ * @param name Child scope name
+ * @return <code>true</code> if it does have it, <code>false</code> otherwise
+ */
+ public boolean hasChildScope(String name) {
return scope.hasChildScope(name);
}
- public boolean hasParent() {
+ /**
+ * If this scope has a parent
+ * @return <code>true</code> if this scope has a parent scope, <code>false</code> otherwise
+ */
+ public boolean hasParent() {
return scope.hasParent();
}
@@ -155,5 +233,10 @@
}
- public Resource getResource(String path) {
+ /**
+ * Return resource by name
+ * @param path Resource name
+ * @return Resource with given name
+ */
+ public Resource getResource(String path) {
return scope.getResource(path);
}
Index: /java/server/trunk/src/org/red5/server/adapter/AbstractScopeAdapter.java
===================================================================
--- /java/server/trunk/src/org/red5/server/adapter/AbstractScopeAdapter.java (revision 1406)
+++ /java/server/trunk/src/org/red5/server/adapter/AbstractScopeAdapter.java (revision 1597)
@@ -42,57 +42,87 @@
private boolean canHandleEvent = true;
- public void setCanStart(boolean canStart) {
+ /**
+ * Setter for property 'canStart'.
+ *
+ * @param canStart Value to set for property 'canStart'.
+ */
+ public void setCanStart(boolean canStart) {
this.canStart = canStart;
}
- public void setCanCallService(boolean canCallService) {
+ /**
+ * Setter for property 'canCallService'.
+ *
+ * @param canCallService Value to set for property 'canCallService'.
+ */
+ public void setCanCallService(boolean canCallService) {
this.canCallService = canCallService;
}
- public void setCanConnect(boolean canConnect) {
+ /**
+ * Setter for property 'canConnect'.
+ *
+ * @param canConnect Value to set for property 'canConnect'.
+ */
+ public void setCanConnect(boolean canConnect) {
this.canConnect = canConnect;
}
- public void setJoin(boolean canJoin) {
+ /**
+ * Setter for property 'join'.
+ *
+ * @param canJoin Value to set for property 'join'.
+ */
+ public void setJoin(boolean canJoin) {
this.canJoin = canJoin;
}
- public boolean start(IScope scope) {
+ /** {@inheritDoc} */
+ public boolean start(IScope scope) {
return canStart;
}
- public void stop(IScope scope) {
+ /** {@inheritDoc} */
+ public void stop(IScope scope) {
// nothing
}
- public boolean connect(IConnection conn, IScope scope, Object[] params) {
+ /** {@inheritDoc} */
+ public boolean connect(IConnection conn, IScope scope, Object[] params) {
return canConnect;
}
- public void disconnect(IConnection conn, IScope scope) {
+ /** {@inheritDoc} */
+ public void disconnect(IConnection conn, IScope scope) {
// nothing
}
- public boolean join(IClient client, IScope scope) {
+ /** {@inheritDoc} */
+ public boolean join(IClient client, IScope scope) {
return canJoin;
}
- public void leave(IClient client, IScope scope) {
+ /** {@inheritDoc} */
+ public void leave(IClient client, IScope scope) {
// nothing
}
- public boolean serviceCall(IConnection conn, IServiceCall call) {
+ /** {@inheritDoc} */
+ public boolean serviceCall(IConnection conn, IServiceCall call) {
return canCallService;
}
- public boolean addChildScope(IBasicScope scope) {
+ /** {@inheritDoc} */
+ public boolean addChildScope(IBasicScope scope) {
return canAddChildScope;
}
- public void removeChildScope(IBasicScope scope) {
+ /** {@inheritDoc} */
+ public void removeChildScope(IBasicScope scope) {
// TODO Auto-generated method stub
}
- public boolean handleEvent(IEvent event) {
+ /** {@inheritDoc} */
+ public boolean handleEvent(IEvent event) {
return canHandleEvent;
}
Index: /java/server/trunk/src/org/red5/server/so/SharedObjectEvent.java
===================================================================
--- /java/server/trunk/src/org/red5/server/so/SharedObjectEvent.java (revision 1519)
+++ /java/server/trunk/src/org/red5/server/so/SharedObjectEvent.java (revision 1597)
@@ -34,17 +34,21 @@
}
- public String getKey() {
+ /** {@inheritDoc} */
+ public String getKey() {
return key;
}
- public Type getType() {
+ /** {@inheritDoc} */
+ public Type getType() {
return type;
}
- public Object getValue() {
+ /** {@inheritDoc} */
+ public Object getValue() {
return value;
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public String toString() {
return "SOEvent(" + getType() + ", " + getKey() + ", " + getValue()
Index: /java/server/trunk/src/org/red5/server/so/SharedObjectMessage.java
===================================================================
--- /java/server/trunk/src/org/red5/server/so/SharedObjectMessage.java (revision 1406)
+++ /java/server/trunk/src/org/red5/server/so/SharedObjectMessage.java (revision 1597)
@@ -50,34 +50,54 @@
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public byte getDataType() {
return TYPE_SHARED_OBJECT;
}
- public int getVersion() {
+ /** {@inheritDoc} */
+ public int getVersion() {
return version;
}
- protected void setVersion(int version) {
+ /**
+ * Setter for property 'version'.
+ *
+ * @param version Value to set for property 'version'.
+ */
+ protected void setVersion(int version) {
this.version = version;
}
- public String getName() {
+ /** {@inheritDoc} */
+ public String getName() {
return name;
}
- protected void setName(String name) {
+ /**
+ * Setter for property 'name'.
+ *
+ * @param name Value to set for property 'name'.
+ */
+ protected void setName(String name) {
this.name = name;
}
- public boolean isPersistent() {
+ /** {@inheritDoc} */
+ public boolean isPersistent() {
return persistent;
}
- protected void setIsPersistent(boolean persistent) {
+ /**
+ * Setter for property 'isPersistent'.
+ *
+ * @param persistent Value to set for property 'isPersistent'.
+ */
+ protected void setIsPersistent(boolean persistent) {
this.persistent = persistent;
}
- public void addEvent(ISharedObjectEvent event) {
+ /** {@inheritDoc} */
+ public void addEvent(ISharedObjectEvent event) {
events.add(event);
}
@@ -87,36 +107,44 @@
}
- public LinkedList<ISharedObjectEvent> getEvents() {
+ /** {@inheritDoc} */
+ public LinkedList<ISharedObjectEvent> getEvents() {
return events;
}
- public void addEvent(ISharedObjectEvent.Type type, String key, Object value) {
+ /** {@inheritDoc} */
+ public void addEvent(ISharedObjectEvent.Type type, String key, Object value) {
events.add(new SharedObjectEvent(type, key, value));
}
- public void clear() {
+ /** {@inheritDoc} */
+ public void clear() {
events.clear();
}
- public boolean isEmpty() {
+ /** {@inheritDoc} */
+ public boolean isEmpty() {
return events.isEmpty();
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public Type getType() {
return Type.SHARED_OBJECT;
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public Object getObject() {
return getEvents();
}
- @Override
+ /** {@inheritDoc} */
+ @Override
protected void releaseInternal() {
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public String toString() {
final StringBuffer sb = new StringBuffer();
Index: /java/server/trunk/src/org/red5/server/so/SharedObjectScope.java
===================================================================
--- /java/server/trunk/src/org/red5/server/so/SharedObjectScope.java (revision 1574)
+++ /java/server/trunk/src/org/red5/server/so/SharedObjectScope.java (revision 1597)
@@ -76,43 +76,56 @@
}
- public void setPersistenceClass(String persistenceClass) {
+ /**
+ * Setter for property 'persistenceClass'.
+ *
+ * @param persistenceClass Value to set for property 'persistenceClass'.
+ */
+ public void setPersistenceClass(String persistenceClass) {
// Nothing to do here, the shared object will take care of persistence.
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public IPersistenceStore getStore() {
return so.getStore();
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public String getName() {
return so.getName();
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public void setName(String name) {
so.setName(name);
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public String getPath() {
return so.getPath();
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public void setPath(String path) {
so.setPath(path);
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public String getType() {
return so.getType();
}
- public boolean isPersistentObject() {
+ /** {@inheritDoc} */
+ public boolean isPersistentObject() {
return so.isPersistentObject();
}
- public synchronized void beginUpdate() {
+ /** {@inheritDoc} */
+ public synchronized void beginUpdate() {
if (!lock.isHeldByCurrentThread()) {
lock.lock();
@@ -121,5 +134,6 @@
}
- public synchronized void beginUpdate(IEventListener listener) {
+ /** {@inheritDoc} */
+ public synchronized void beginUpdate(IEventListener listener) {
if (!lock.isHeldByCurrentThread()) {
lock.lock();
@@ -128,5 +142,6 @@
}
- public synchronized void endUpdate() {
+ /** {@inheritDoc} */
+ public synchronized void endUpdate() {
so.endUpdate();
if (so.updateCounter == 0) {
@@ -135,9 +150,11 @@
}
- public int getVersion() {
+ /** {@inheritDoc} */
+ public int getVersion() {
return so.getVersion();
}
- public void sendMessage(String handler, List arguments) {
+ /** {@inheritDoc} */
+ public void sendMessage(String handler, List arguments) {
beginUpdate();
so.sendMessage(handler, arguments);
@@ -198,5 +215,6 @@
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public synchronized boolean removeAttribute(String name) {
beginUpdate();
@@ -214,5 +232,6 @@
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public synchronized void removeAttributes() {
beginUpdate();
@@ -227,5 +246,6 @@
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public void addEventListener(IEventListener listener) {
super.addEventListener(listener);
@@ -239,5 +259,6 @@
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public void removeEventListener(IEventListener listener) {
so.unregister(listener);
@@ -254,24 +275,29 @@
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public boolean hasAttribute(String name) {
return so.hasAttribute(name);
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public Object getAttribute(String name) {
return so.getAttribute(name);
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public Set<String> getAttributeNames() {
return so.getAttributeNames();
}
- public Map<String, Object> getData() {
+ /** {@inheritDoc} */
+ public Map<String, Object> getData() {
return so.getData();
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public void dispatchEvent(IEvent e) {
if (e.getType() != IEvent.Type.SHARED_OBJECT
@@ -327,5 +353,6 @@
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public synchronized boolean setAttribute(String name, Object value) {
beginUpdate();
@@ -343,5 +370,6 @@
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public synchronized void setAttributes(IAttributeStore values) {
beginUpdate();
@@ -356,5 +384,6 @@
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public synchronized void setAttributes(Map<String, Object> values) {
beginUpdate();
@@ -369,24 +398,29 @@
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public String toString() {
return "Shared Object: " + getName();
}
- public synchronized void addSharedObjectListener(
+ /** {@inheritDoc} */
+ public synchronized void addSharedObjectListener(
ISharedObjectListener listener) {
serverListeners.add(listener);
}
- public synchronized void removeSharedObjectListener(
+ /** {@inheritDoc} */
+ public synchronized void removeSharedObjectListener(
ISharedObjectListener listener) {
serverListeners.remove(listener);
}
- public void registerServiceHandler(Object handler) {
+ /** {@inheritDoc} */
+ public void registerServiceHandler(Object handler) {
registerServiceHandler("", handler);
}
- public void registerServiceHandler(String name, Object handler) {
+ /** {@inheritDoc} */
+ public void registerServiceHandler(String name, Object handler) {
if (name == null) {
name = "";
@@ -399,5 +433,6 @@
}
- public void unregisterServiceHandler(String name) {
+ /** {@inheritDoc} */
+ public void unregisterServiceHandler(String name) {
if (name == null) {
name = "";
@@ -406,5 +441,6 @@
}
- public Object getServiceHandler(String name) {
+ /** {@inheritDoc} */
+ public Object getServiceHandler(String name) {
if (name == null) {
name = "";
@@ -413,5 +449,6 @@
}
- public Set<String> getServiceHandlerNames() {
+ /** {@inheritDoc} */
+ public Set<String> getServiceHandlerNames() {
return Collections.unmodifiableSet(handlers.keySet());
}
@@ -442,9 +479,11 @@
}
- public boolean clear() {
+ /** {@inheritDoc} */
+ public boolean clear() {
return so.clear();
}
- public void close() {
+ /** {@inheritDoc} */
+ public void close() {
so.close();
so = null;
Index: /java/server/trunk/src/org/red5/server/so/ISharedObjectMessage.java
===================================================================
--- /java/server/trunk/src/org/red5/server/so/ISharedObjectMessage.java (revision 1406)
+++ /java/server/trunk/src/org/red5/server/so/ISharedObjectMessage.java (revision 1597)
@@ -62,5 +62,10 @@
public void clear();
- public boolean isEmpty();
+ /**
+ * Getter for property 'empty'.
+ *
+ * @return Value for property 'empty'.
+ */
+ public boolean isEmpty();
}
Index: /java/server/trunk/src/org/red5/server/so/ClientSharedObject.java
===================================================================
--- /java/server/trunk/src/org/red5/server/so/ClientSharedObject.java (revision 1575)
+++ /java/server/trunk/src/org/red5/server/so/ClientSharedObject.java (revision 1597)
@@ -88,17 +88,21 @@
}
- public boolean isConnected() {
+ /** {@inheritDoc} */
+ public boolean isConnected() {
return initialSyncReceived;
}
- public void addSharedObjectListener(ISharedObjectListener listener) {
+ /** {@inheritDoc} */
+ public void addSharedObjectListener(ISharedObjectListener listener) {
listeners.add(listener);
}
- public void removeSharedObjectListener(ISharedObjectListener listener) {
+ /** {@inheritDoc} */
+ public void removeSharedObjectListener(ISharedObjectListener listener) {
listeners.remove(listener);
}
- public void dispatchEvent(IEvent e) {
+ /** {@inheritDoc} */
+ public void dispatchEvent(IEvent e) {
if (e.getType() != IEvent.Type.SHARED_OBJECT
|| !(e instanceof ISharedObjectMessage)) {
@@ -213,5 +217,6 @@
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public synchronized boolean setAttribute(String name, Object value) {
ownerMessage.addEvent(Type.SERVER_SET_ATTRIBUTE, name, null);
@@ -220,5 +225,6 @@
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public synchronized boolean removeAttribute(String name) {
ownerMessage.addEvent(Type.SERVER_DELETE_ATTRIBUTE, name, null);
@@ -227,5 +233,6 @@
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public synchronized void sendMessage(String handler, List arguments) {
ownerMessage.addEvent(Type.SERVER_SEND_MESSAGE, handler, arguments);
@@ -233,5 +240,6 @@
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public synchronized void removeAttributes() {
// TODO: there must be a direct way to clear the SO on the client
@@ -245,5 +253,6 @@
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public synchronized void beginUpdate() {
if (!lock.isHeldByCurrentThread()) {
@@ -253,5 +262,6 @@
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public synchronized void beginUpdate(IEventListener listener) {
if (!lock.isHeldByCurrentThread()) {
@@ -261,5 +271,6 @@
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public synchronized void endUpdate() {
super.endUpdate();
@@ -269,25 +280,31 @@
}
- public void lock() {
+ /** {@inheritDoc} */
+ public void lock() {
lock.lock();
}
- public void unlock() {
+ /** {@inheritDoc} */
+ public void unlock() {
lock.unlock();
}
- public boolean isLocked() {
+ /** {@inheritDoc} */
+ public boolean isLocked() {
return lock.isLocked();
}
- public void registerServiceHandler(Object handler) {
+ /** {@inheritDoc} */
+ public void registerServiceHandler(Object handler) {
registerServiceHandler("", handler);
}
- public void unregisterServiceHandler(String name) {
+ /** {@inheritDoc} */
+ public void unregisterServiceHandler(String name) {
handlers.remove(name);
}
- public void registerServiceHandler(String name, Object handler) {
+ /** {@inheritDoc} */
+ public void registerServiceHandler(String name, Object handler) {
if (name == null) {
name = "";
@@ -296,5 +313,6 @@
}
- public Object getServiceHandler(String name) {
+ /** {@inheritDoc} */
+ public Object getServiceHandler(String name) {
if (name == null) {
name = "";
@@ -303,49 +321,61 @@
}
- public Set<String> getServiceHandlerNames() {
+ /** {@inheritDoc} */
+ public Set<String> getServiceHandlerNames() {
return Collections.unmodifiableSet(handlers.keySet());
}
- public Boolean getBoolAttribute(String name) {
+ /** {@inheritDoc} */
+ public Boolean getBoolAttribute(String name) {
return (Boolean) getAttribute(name);
}
- public Byte getByteAttribute(String name) {
+ /** {@inheritDoc} */
+ public Byte getByteAttribute(String name) {
return (Byte) getAttribute(name);
}
- public Double getDoubleAttribute(String name) {
+ /** {@inheritDoc} */
+ public Double getDoubleAttribute(String name) {
return (Double) getAttribute(name);
}
- public Integer getIntAttribute(String name) {
+ /** {@inheritDoc} */
+ public Integer getIntAttribute(String name) {
return (Integer) getAttribute(name);
}
- public List getListAttribute(String name) {
+ /** {@inheritDoc} */
+ public List getListAttribute(String name) {
return (List) getAttribute(name);
}
- public Long getLongAttribute(String name) {
+ /** {@inheritDoc} */
+ public Long getLongAttribute(String name) {
return (Long) getAttribute(name);
}
- public Map getMapAttribute(String name) {
+ /** {@inheritDoc} */
+ public Map getMapAttribute(String name) {
return (Map) getAttribute(name);
}
- public Set getSetAttribute(String name) {
+ /** {@inheritDoc} */
+ public Set getSetAttribute(String name) {
return (Set) getAttribute(name);
}
- public Short getShortAttribute(String name) {
+ /** {@inheritDoc} */
+ public Short getShortAttribute(String name) {
return (Short) getAttri
Note:
Diffs are chopped if more than 25k.
This is to get past the limit on the mailing list.
More information about the Red5commits
mailing list