[Red5commits] [2402] Cleanup docs, fixing typo's, adding missing license headers etc.
TTriemstra
luke at codegent.com
Tue Oct 16 12:10:19 PDT 2007
Cleanup docs, fixing typo's, adding missing license headers etc.
Timestamp: 10/16/07 14:03:47 EST (less than one hour ago)
Change: 2402
Author: TTriemstra
Files (see diff or trac for details):
java/server/trunk/src/org/red5/compatibility/flex/messaging/io/ArrayCollection.java
java/server/trunk/src/org/red5/compatibility/flex/messaging/io/ObjectProxy.java
java/server/trunk/src/org/red5/compatibility/flex/messaging/messages/AbstractMessage.java
java/server/trunk/src/org/red5/compatibility/flex/messaging/messages/AsyncMessage.java
java/server/trunk/src/org/red5/compatibility/flex/messaging/messages/CommandMessage.java
java/server/trunk/src/org/red5/io/amf/AMF.java
java/server/trunk/src/org/red5/io/amf/Input.java
java/server/trunk/src/org/red5/io/amf3/Input.java
java/server/trunk/src/org/red5/io/flv/FLVHeader.java
java/server/trunk/src/org/red5/io/flv/IKeyFrameDataAnalyzer.java
java/server/trunk/src/org/red5/io/flv/impl/FLVReader.java
java/server/trunk/src/org/red5/io/flv/impl/FLVService.java
java/server/trunk/src/org/red5/io/flv/impl/Tag.java
java/server/trunk/src/org/red5/server/ClientMBean.java
java/server/trunk/src/org/red5/server/ClientRegistry.java
java/server/trunk/src/org/red5/server/CoreHandlerMBean.java
java/server/trunk/src/org/red5/server/ListMBean.java
java/server/trunk/src/org/red5/server/LoaderMBean.java
java/server/trunk/src/org/red5/server/Standalone.java
java/server/trunk/src/org/red5/server/jboss/JbossLoader.java
java/server/trunk/src/org/red5/server/jboss/JbossLoaderMBean.java
java/server/trunk/src/org/red5/server/jmx/JMXFactory.java
java/server/trunk/src/org/red5/server/jmx/JMXUtil.java
java/server/trunk/src/org/red5/server/messaging/OOBControlMessage.java
java/server/trunk/src/org/red5/server/net/protocol/HandshakeFailedException.java
java/server/trunk/src/org/red5/server/net/protocol/ProtocolException.java
java/server/trunk/src/org/red5/server/net/protocol/ProtocolState.java
java/server/trunk/src/org/red5/server/net/remoting/FlexMessagingService.java
java/server/trunk/src/org/red5/server/net/remoting/IRemotingCallback.java
java/server/trunk/src/org/red5/server/net/remoting/RemotingClient.java
java/server/trunk/src/org/red5/server/net/remoting/RemotingConnection.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/rtmp/BaseRTMPHandler.java
java/server/trunk/src/org/red5/server/net/rtmp/Channel.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/RTMPMinaTransport.java
java/server/trunk/src/org/red5/server/net/rtmp/RTMPMinaTransportMBean.java
java/server/trunk/src/org/red5/server/net/rtmp/RTMPUtils.java
java/server/trunk/src/org/red5/server/net/rtmp/codec/IEventDecoder.java
java/server/trunk/src/org/red5/server/net/rtmp/codec/IEventEncoder.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/persistence/FilePersistence.java
java/server/trunk/src/org/red5/server/script/jython/JythonScriptFactory.java
java/server/trunk/src/org/red5/server/statistics/XmlRpcScopeStatistics.java
java/server/trunk/src/org/red5/server/tomcat/TomcatLoader.java
java/server/trunk/src/org/red5/server/war/IRemotableList.java
java/server/trunk/src/org/red5/server/war/RemotableList.java
java/server/trunk/src/org/red5/server/war/SubContextLoaderServlet.java
java/server/trunk/src/org/red5/server/war/WebSettings.java
Trac: http://mirror1.cvsdude.com/trac/osflash/red5/changeset/2402
Index: /java/server/trunk/src/org/red5/server/jboss/JbossLoader.java
===================================================================
--- /java/server/trunk/src/org/red5/server/jboss/JbossLoader.java (revision 2397)
+++ /java/server/trunk/src/org/red5/server/jboss/JbossLoader.java (revision 2402)
@@ -34,5 +34,5 @@
/**
- * Red5 loader for Jboss
+ * Red5 loader for JBoss.
*
* @author The Red5 Project (red5 at osflash.org)
@@ -55,5 +55,5 @@
*/
public void start() {
- logger.info("Loading jboss service");
+ logger.info("Loading JBoss service");
System.setProperty("red5.deployment.type", "jboss");
@@ -120,5 +120,5 @@
*/
public void stop() {
- logger.info("Shutting down jboss context");
+ logger.info("Shutting down JBoss context");
try {
//prepare spring for shutdown
@@ -142,5 +142,5 @@
//LogFactory.release(Thread.currentThread().getContextClassLoader());
} catch (Exception e) {
- logger.warn("Jboss could not be stopped", e);
+ logger.warn("JBoss could not be stopped", e);
}
}
Index: /java/server/trunk/src/org/red5/server/jboss/JbossLoaderMBean.java
===================================================================
--- /java/server/trunk/src/org/red5/server/jboss/JbossLoaderMBean.java (revision 2234)
+++ /java/server/trunk/src/org/red5/server/jboss/JbossLoaderMBean.java (revision 2402)
@@ -21,5 +21,5 @@
/**
- * Red5 loader mbean for Jboss
+ * Red5 loader mbean for JBoss.
*
* @author The Red5 Project (red5 at osflash.org)
Index: /java/server/trunk/src/org/red5/server/persistence/FilePersistence.java
===================================================================
--- /java/server/trunk/src/org/red5/server/persistence/FilePersistence.java (revision 2397)
+++ /java/server/trunk/src/org/red5/server/persistence/FilePersistence.java (revision 2402)
@@ -45,5 +45,4 @@
* @author The Red5 Project (red5 at osflash.org)
* @author Joachim Bauch (jojo at struktur.de)
- *
*/
public class FilePersistence extends RamPersistence {
Index: /java/server/trunk/src/org/red5/server/ClientRegistry.java
===================================================================
--- /java/server/trunk/src/org/red5/server/ClientRegistry.java (revision 2140)
+++ /java/server/trunk/src/org/red5/server/ClientRegistry.java (revision 2402)
@@ -34,5 +34,7 @@
/**
* Registry for clients. Associates client with it's id so it's possible to get client by id
- * from whenever we need
+ * from whenever we need.
+ *
+ * @author The Red5 Project (red5 at osflash.org)
*/
public class ClientRegistry implements IClientRegistry, ClientRegistryMBean {
Index: /java/server/trunk/src/org/red5/server/tomcat/TomcatLoader.java
===================================================================
--- /java/server/trunk/src/org/red5/server/tomcat/TomcatLoader.java (revision 2397)
+++ /java/server/trunk/src/org/red5/server/tomcat/TomcatLoader.java (revision 2402)
@@ -43,5 +43,5 @@
/**
- * Red5 loader for Tomcat
+ * Red5 loader for Tomcat.
*/
public class TomcatLoader extends LoaderBase implements
@@ -54,9 +54,7 @@
* Check whether file matches filter rules
*
- * @param dir
- * Dir
- * @param name
- * File name
- * @return true if file does match filter rules, false otherwise
+ * @param dir Dir
+ * @param name File name
+ * @return true If file does match filter rules, false otherwise
*/
public boolean accept(File dir, String name) {
@@ -74,5 +72,5 @@
/**
* We store the application context in a ThreadLocal so we can access it
- * later
+ * later.
*/
protected static ThreadLocal<ApplicationContext> applicationContext = new ThreadLocal<ApplicationContext>();
@@ -94,25 +92,25 @@
/**
- * Base container host
+ * Base container host.
*/
private Host baseHost;
/**
- * Tomcat connector
+ * Tomcat connector.
*/
protected Connector connector;
/**
- * Embedded Tomcat service (like Catalina)
+ * Embedded Tomcat service (like Catalina).
*/
protected Embedded embedded;
/**
- * Tomcat engine
+ * Tomcat engine.
*/
protected Engine engine;
/**
- * Tomcat realm
+ * Tomcat realm.
*/
protected Realm realm;
@@ -124,11 +122,9 @@
/**
- * Add context from path and docbase
- *
- * @param path
- * Path
- * @param docBase
- * Docbase
- * @return Catalina context (that is, web application)
+ * Add context from path and docbase.
+ *
+ * @param path Path
+ * @param docBase Docbase
+ * @return Catalina context (that is, web application)
*/
public org.apache.catalina.Context addContext(String path, String docBase) {
@@ -141,5 +137,5 @@
/**
- * Get base host
+ * Get base host.
*
* @return Base host
@@ -150,5 +146,5 @@
/**
- * Return connector
+ * Return connector.
*
* @return Connector
@@ -159,5 +155,5 @@
/**
- * Getter for embedded object
+ * Getter for embedded object.
*
* @return Embedded object
@@ -168,5 +164,5 @@
/**
- * Return Tomcat engine
+ * Return Tomcat engine.
*
* @return Tomcat engine
@@ -177,5 +173,5 @@
/**
- * Getter for realm
+ * Getter for realm.
*
* @return Realm
@@ -186,5 +182,5 @@
/**
- * Initialization
+ * Initialization.
*/
public void init() {
@@ -225,5 +221,5 @@
}
- // dump context list
+ // Dump context list
if (log.isDebugEnabled()) {
for (Container cont : baseHost.findChildren()) {
@@ -231,8 +227,8 @@
}
}
- // set a realm
+ // Set a realm
embedded.setRealm(realm);
- // dont start tomcats jndi
+ // Don't start Tomcats jndi
embedded.setUseNaming(false);
@@ -240,8 +236,8 @@
engine.addChild(baseHost);
- // add new Engine to set of Engine for embedded server
+ // Add new Engine to set of Engine for embedded server
embedded.addEngine(engine);
- // add new Connector to set of Connectors for embedded server,
+ // Add new Connector to set of Connectors for embedded server,
// associated with Engine
embedded.addConnector(connector);
@@ -249,15 +245,15 @@
setApplicationLoader(new TomcatApplicationLoader(embedded, baseHost));
- // start server
+ // Start server
try {
- log.info("Starting tomcat servlet engine");
+ log.info("Starting Tomcat servlet engine");
embedded.start();
} catch (org.apache.catalina.LifecycleException e) {
- log.error("Error loading tomcat", e);
- }
- }
-
- /**
- * Setter for application context
+ log.error("Error loading Tomcat", e);
+ }
+ }
+
+ /**
+ * Setter for application context.
*
* @param context
@@ -273,8 +269,7 @@
/**
- * Set base host
- *
- * @param baseHost
- * Base host
+ * Set base host.
+ *
+ * @param baseHost Base host
*/
public void setBaseHost(Host baseHost) {
@@ -284,5 +279,5 @@
/**
- * Set connector
+ * Set connector.
*
* @param connector
@@ -295,5 +290,5 @@
/**
- * Set additional connectors
+ * Set additional connectors.
*
* @param connectors
@@ -310,5 +305,5 @@
/**
- * Set additional contexts
+ * Set additional contexts.
*
* @param contexts
@@ -326,5 +321,5 @@
/**
- * Setter for embedded object
+ * Setter for embedded object.
*
* @param embedded
@@ -337,8 +332,7 @@
/**
- * Set Tomcat engine implementation
- *
- * @param engine
- * Tomcat engine
+ * Set Tomcat engine implementation.
+ *
+ * @param engine Tomcat engine
*/
public void setEngine(Engine engine) {
@@ -348,8 +342,7 @@
/**
- * Set additional hosts
- *
- * @param hosts
- * List of hosts added to engine
+ * Set additional hosts.
+ *
+ * @param hosts List of hosts added to engine
*/
public void setHosts(List<Host> hosts) {
@@ -363,5 +356,5 @@
/**
- * Setter for realm
+ * Setter for realm.
*
* @param realm
@@ -374,5 +367,5 @@
/**
- * Set additional valves
+ * Set additional valves.
*
* @param valves
@@ -389,8 +382,8 @@
/**
- * Shut server down
+ * Shut server down.
*/
public void shutdown() {
- log.info("Shutting down tomcat context");
+ log.info("Shutting down Tomcat context");
JMXAgent.shutdown();
try {
Index: /java/server/trunk/src/org/red5/server/statistics/XmlRpcScopeStatistics.java
===================================================================
--- /java/server/trunk/src/org/red5/server/statistics/XmlRpcScopeStatistics.java (revision 1979)
+++ /java/server/trunk/src/org/red5/server/statistics/XmlRpcScopeStatistics.java (revision 2402)
@@ -54,5 +54,6 @@
/**
- * Create new scope statistic
+ * Create new scope statistic.
+ *
* @param globalScope Global scope ref
*/
@@ -62,5 +63,5 @@
/**
- * Setter for global scope
+ * Setter for global scope.
*
* @param scope Value to set for property 'globalScope'.
@@ -73,8 +74,8 @@
* Resolve path to scope.
*
- * @param path
- * path to return scope for
- * @return the scope for the given path
- * @throws ScopeNotFoundException Thrown when scope with given path can't be resolved
+ * @param path Path to return scope for
+ * @return The scope for the given path
+ *
+ * @throws ScopeNotFoundException Thrown when scope with given path can't be resolved
*/
private IScope getScope(String path) throws ScopeNotFoundException {
@@ -105,7 +106,6 @@
* Return subscopes of another scope.
*
- * @param path
- * path of scope to return subscopes of
- * @return list of subscope names
+ * @param path Path of scope to return subscopes of
+ * @return List of subscope names
*/
public String[] getScopes(String path) {
@@ -124,5 +124,5 @@
* Return attributes of the global scope.
*
- * @return the scope's attributes
+ * @return The scope's attributes
*/
public Map<String, Object> getScopeAttributes() {
@@ -183,7 +183,6 @@
* Return attributes of a given scope.
*
- * @param path
- * path of scope to return attributes of
- * @return the scope's attributes
+ * @param path Path of scope to return attributes of
+ * @return The scope's attributes
*/
public Map<String, Object> getScopeAttributes(String path) {
@@ -204,7 +203,6 @@
* Return informations about shared objects of a given scope.
*
- * @param path
- * path of scope to return shared objects for
- * @return a mapping containing shared object name -> (persistent, data)
+ * @param path Path of scope to return shared objects for
+ * @return A mapping containing the shared object name -> (persistent, data)
*/
public Map<String, Object> getSharedObjects(String path) {
Index: /java/server/trunk/src/org/red5/server/ListMBean.java
===================================================================
--- /java/server/trunk/src/org/red5/server/ListMBean.java (revision 1947)
+++ /java/server/trunk/src/org/red5/server/ListMBean.java (revision 2402)
@@ -21,4 +21,6 @@
/**
+ *
+ * @author The Red5 Project (red5 at osflash.org)
*/
public interface ListMBean {
Index: /java/server/trunk/src/org/red5/server/CoreHandlerMBean.java
===================================================================
--- /java/server/trunk/src/org/red5/server/CoreHandlerMBean.java (revision 1947)
+++ /java/server/trunk/src/org/red5/server/CoreHandlerMBean.java (revision 2402)
@@ -29,4 +29,6 @@
/**
* Base IScopeHandler implementation
+ *
+ * @author The Red5 Project (red5 at osflash.org)
*/
public interface CoreHandlerMBean {
Index: /java/server/trunk/src/org/red5/server/messaging/OOBControlMessage.java
===================================================================
--- /java/server/trunk/src/org/red5/server/messaging/OOBControlMessage.java (revision 1698)
+++ /java/server/trunk/src/org/red5/server/messaging/OOBControlMessage.java (revision 2402)
@@ -32,4 +32,5 @@
* interested for receiving. It's a string of any form.
* XXX shall we design a standard form for Target, like "class.instance"?
+ *
* @author The Red5 Project (red5 at osflash.org)
* @author Steven Gong (steven.gong at gmail.com)
Index: /java/server/trunk/src/org/red5/server/net/protocol/ProtocolException.java
===================================================================
--- /java/server/trunk/src/org/red5/server/net/protocol/ProtocolException.java (revision 2216)
+++ /java/server/trunk/src/org/red5/server/net/protocol/ProtocolException.java (revision 2402)
@@ -23,10 +23,11 @@
/**
- * Base exception for all protocol exeptions
+ * Base exception for all protocol exeptions.
*/
private static final long serialVersionUID = -5380844081848027068L;
/**
- * Create protocol exception with given message
+ * Create protocol exception with given message.
+ *
* @param message
*/
@@ -36,5 +37,6 @@
/**
- * Create protocol exception with given message and cause
+ * Create protocol exception with given message and cause.
+ *
* @param message
* @param cause
Index: /java/server/trunk/src/org/red5/server/net/protocol/ProtocolState.java
===================================================================
--- /java/server/trunk/src/org/red5/server/net/protocol/ProtocolState.java (revision 1698)
+++ /java/server/trunk/src/org/red5/server/net/protocol/ProtocolState.java (revision 2402)
@@ -21,39 +21,40 @@
/**
- * Represents current state of protocol
+ * Represents current state of protocol.
*/
public class ProtocolState {
/**
- * Session key constant
+ * Session key constant.
*/
public static final String SESSION_KEY = "protocol_state";
/**
- * Decoding finished successfully state constant
+ * Decoding finished successfully state constant.
*/
public static byte DECODER_OK = 0x00;
/**
- * Deconding continues state constant
+ * Deconding continues state constant.
*/
public static byte DECODER_CONTINUE = 0x01;
/**
- * Decoder is buffering state constant
+ * Decoder is buffering state constant.
*/
public static byte DECODER_BUFFER = 0x02;
/**
- * Classes like the RTMP state object will extend this marker interface
+ * Classes like the RTMP state object will extend this marker interface.
*/
private int decoderBufferAmount;
/**
- * Current decoder state, decoder is stopped by default
+ * Current decoder state, decoder is stopped by default.
*/
private byte decoderState = DECODER_OK;
/**
- * Returns current buffer amount
+ * Returns current buffer amount.
+ *
* @return Buffer amount
*/
@@ -73,6 +74,5 @@
/**
- * Set decoding state as "needed to be continued"
- *
+ * Set decoding state as "needed to be continued".
*/
public void continueDecoding() {
@@ -81,5 +81,5 @@
/**
- * Checks whether remaining buffer size is greater or equal than buffer amount and so if it makes sense to start decoding
+ * Checks whether remaining buffer size is greater or equal than buffer amount and so if it makes sense to start decoding.
*
* @param remaining Remaining buffer size
@@ -96,5 +96,4 @@
/**
* Starts decoding. Sets state to "ready" and clears buffer amount.
- *
*/
public void startDecoding() {
@@ -104,5 +103,6 @@
/**
- * Checks whether decoding is complete
+ * Checks whether decoding is complete.
+ *
* @return <code>true</code> if decoding has finished, <code>false</code> otherwise
*/
@@ -112,5 +112,6 @@
/**
- * Checks whether decoding process can be continued
+ * Checks whether decoding process can be continued.
+ *
* @return <code>true</code> if decoding can be continued, <code>false</code> otherwise
*/
Index: /java/server/trunk/src/org/red5/server/net/protocol/HandshakeFailedException.java
===================================================================
--- /java/server/trunk/src/org/red5/server/net/protocol/HandshakeFailedException.java (revision 2111)
+++ /java/server/trunk/src/org/red5/server/net/protocol/HandshakeFailedException.java (revision 2402)
@@ -29,4 +29,5 @@
/**
* Create handshake failed exception with given message
+ *
* @param message
*/
Index: /java/server/trunk/src/org/red5/server/net/rtmp/RTMPConnection.java
===================================================================
--- /java/server/trunk/src/org/red5/server/net/rtmp/RTMPConnection.java (revision 2397)
+++ /java/server/trunk/src/org/red5/server/net/rtmp/RTMPConnection.java (revision 2402)
@@ -110,5 +110,5 @@
/**
- * Identifier for remote calls
+ * Identifier for remote calls.
*/
protected AtomicInteger invokeId = new AtomicInteger(1);
@@ -120,5 +120,5 @@
/**
- * Deferred results set
+ * Deferred results set.
*
* @see org.red5.server.net.rtmp.DeferredResult
@@ -127,5 +127,5 @@
/**
- * Last ping timestamp
+ * Last ping timestamp.
*/
protected int lastPingTime = -1;
@@ -142,15 +142,15 @@
/**
- * Name of quartz job that keeps connection alive
+ * Name of quartz job that keeps connection alive.
*/
protected String keepAliveJobName;
/**
- * Ping interval in ms to detect dead clients
+ * Ping interval in ms to detect dead clients.
*/
protected int pingInterval = 5000;
/**
- * Max. time in ms after a client is disconnected because of inactivity
+ * Maximum time in ms after a client is disconnected because of inactivity.
*/
protected int maxInactivity = 60000;
@@ -167,40 +167,40 @@
/**
- * Number of bytes to read next
+ * Number of bytes to read next.
*/
private int nextBytesRead = 120 * 1024;
/**
- * Number of bytes the client reported to have received
+ * Number of bytes the client reported to have received.
*/
private int clientBytesRead = 0;
/**
- * Bandwidth configure
+ * Bandwidth configure.
*/
private IConnectionBWConfig bwConfig;
/**
- * Bandwidth context used by bandwidth controller
+ * Bandwidth context used by bandwidth controller.
*/
private IBWControlContext bwContext;
/**
- * Map for pending video packets and stream IDs
+ * Map for pending video packets and stream IDs.
*/
private Map<Integer, Integer> pendingVideos = new ConcurrentHashMap<Integer, Integer>();
/**
- * Number of streams used
+ * Number of streams used.
*/
private int usedStreams;
/**
- * AMF version, AMF0 by default
+ * AMF version, AMF0 by default.
*/
protected Encoding encoding = Encoding.AMF0;
/**
- * Remembered stream buffer durations
+ * Remembered stream buffer durations.
*/
protected Map<Integer, Integer> streamBuffers = new HashMap<Integer, Integer>();
@@ -222,18 +222,17 @@
/**
- * Max. time in milliseconds to wait for a valid handshake.
+ * Maximum time in milliseconds to wait for a valid handshake.
*/
private int maxHandshakeTimeout = 5000;
/**
- * Creates anonymous RTMP connection without scope
- *
- * @param type
- * Connection type
+ * Creates anonymous RTMP connection without scope.
+ *
+ * @param type Connection type
*/
public RTMPConnection(String type) {
// We start with an anonymous connection without a scope.
// These parameters will be set during the call of "connect" later.
- // super(null, ""); temp fix to get things to compile
+ // super(null, ""); temp fix to get things to compile.
super(type, null, null, 0, null, null, null);
}
@@ -262,5 +261,5 @@
/**
- * Initialize connection
+ * Initialize connection.
*
* @param host
@@ -285,5 +284,5 @@
/**
- * Return AMF protocol encoding used by this connection
+ * Return AMF protocol encoding used by this connection.
*
* @return AMF encoding used by connection
@@ -294,5 +293,5 @@
/**
- * Getter for next available channel id
+ * Getter for next available channel id.
*
* @return Next available channel id
@@ -306,5 +305,5 @@
/**
- * Checks whether channel is used
+ * Checks whether channel is used.
*
* @param channelId
@@ -318,8 +317,7 @@
/**
- * Return channel by id
- *
- * @param channelId
- * Channel id
+ * Return channel by id.
+ *
+ * @param channelId Channel id
* @return Channel by id
*/
@@ -336,8 +334,7 @@
/**
- * Closes channel
- *
- * @param channelId
- * Channel id
+ * Closes channel.
+ *
+ * @param channelId Channel id
*/
public void closeChannel(int channelId) {
@@ -346,5 +343,5 @@
/**
- * Getter for client streams
+ * Getter for client streams.
*
* @return Client streams as array
@@ -375,6 +372,6 @@
*
* @see org.red5.server.stream.OutputStream
- * @param streamId
- * Stream id
+ *
+ * @param streamId Stream id
* @return Output stream object
*/
@@ -390,5 +387,5 @@
/**
- * Getter for video codec factory
+ * Getter for video codec factory.
*
* @return Video codec factory
@@ -460,5 +457,5 @@
}
/**
- * Picking up the PlaylistSubscriberStream defined as a spring
+ * Picking up the PlaylistSubscriberStream defined as a Spring
* prototype in red5-common.xml
*/
@@ -479,5 +476,5 @@
/**
- * Getter for used stream count
+ * Getter for used stream count.
*
* @return Value for property 'usedStreamCount'.
@@ -496,5 +493,5 @@
/**
- * Return stream id for given channel id
+ * Return stream id for given channel id.
*
* @param channelId
@@ -510,5 +507,5 @@
/**
- * Return stream for given channel id
+ * Return stream by given channel id.
*
* @param channelId
@@ -588,8 +585,7 @@
/**
- * Handler for ping event
- *
- * @param ping
- * Ping event context
+ * Handler for ping event.
+ *
+ * @param ping Ping event context
*/
public void ping(Ping ping) {
@@ -598,5 +594,5 @@
/**
- * Write raw byte buffer
+ * Write raw byte buffer.
*
* @param out
@@ -606,5 +602,5 @@
/**
- * Write packet
+ * Write packet.
*
* @param out
@@ -614,5 +610,5 @@
/**
- * Update number of bytes to read next value
+ * Update number of bytes to read next value.
*/
protected void updateBytesRead() {
@@ -628,8 +624,7 @@
/**
- * Read number of recieved bytes
- *
- * @param bytes
- * Number of bytes
+ * Read number of received bytes.
+ *
+ * @param bytes Number of bytes
*/
public void receivedBytesRead(int bytes) {
@@ -643,5 +638,5 @@
* Get number of bytes the client reported to have received.
*
- * @return number of bytes
+ * @return Number of bytes
*/
public int getClientBytesRead() {
@@ -655,5 +650,5 @@
/**
- * Generate next invoke id
+ * Generate next invoke id.
*
* @return Next invoke id for RPC
@@ -664,5 +659,5 @@
/**
- * Register pending call (remote function call that is yet to finish)
+ * Register pending call (remote function call that is yet to finish).
*
* @param invokeId
@@ -710,5 +705,4 @@
call.registerCallback(callback);
}
-
invoke(call);
}
@@ -792,5 +786,5 @@
/**
- * Get pending call service by id
+ * Get pending call service by id.
*
* @param invokeId
@@ -803,5 +797,5 @@
/**
- * Generates new stream name
+ * Generates new stream name.
*
* @return New stream name
@@ -814,6 +808,5 @@
* Mark message as being written.
*
- * @param message
- * Message to mark
+ * @param message Message to mark
*/
protected void writingMessage(Packet message) {
@@ -860,5 +853,5 @@
/**
- * Increases number of dropped messages
+ * Increases number of dropped messages.
*/
protected void messageDropped() {
@@ -891,8 +884,7 @@
/**
- * Marks that pingback was received
- *
- * @param pong
- * Ping object
+ * Marks that pingback was received.
+ *
+ * @param pong Ping object
*/
protected void pingReceived(Ping pong) {
@@ -908,5 +900,5 @@
/**
- * Setter for ping interval
+ * Setter for ping interval.
*
* @param pingInterval
@@ -919,8 +911,8 @@
/**
- * Setter for max. inactivity
+ * Setter for maximum inactivity.
*
* @param maxInactivity
- * Max. time in ms after which a client is disconnected in case
+ * Maximum time in ms after which a c
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