[Red5commits] [1606] RTMP and messaging documentation patch
mklishin
luke at codegent.com
Wed Jan 24 11:05:26 EST 2007
RTMP and messaging documentation patch
Timestamp: 12/28/06 15:39:25 EST (4 weeks ago)
Change: 1606
Author: mklishin
Files (see diff or trac for details):
java/server/trunk/src/org/red5/io/BaseStreamableFileService.java
java/server/trunk/src/org/red5/io/IStreamableFile.java
java/server/trunk/src/org/red5/io/IStreamableFileFactory.java
java/server/trunk/src/org/red5/io/IStreamableFileService.java
java/server/trunk/src/org/red5/io/ITag.java
java/server/trunk/src/org/red5/io/ITagReader.java
java/server/trunk/src/org/red5/io/ITagWriter.java
java/server/trunk/src/org/red5/io/StreamableFileFactory.java
java/server/trunk/src/org/red5/io/amf/Output.java
java/server/trunk/src/org/red5/io/amf3/Output.java
java/server/trunk/src/org/red5/io/filter/ExecutorFilter.java
java/server/trunk/src/org/red5/io/flv/IKeyFrameDataAnalyzer.java
java/server/trunk/src/org/red5/io/flv/impl/FLV.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/FLVWriter.java
java/server/trunk/src/org/red5/io/flv/impl/Tag.java
java/server/trunk/src/org/red5/io/flv/meta/IMetaService.java
java/server/trunk/src/org/red5/io/flv/meta/MetaCue.java
java/server/trunk/src/org/red5/io/flv/meta/MetaData.java
java/server/trunk/src/org/red5/io/flv/meta/MetaService.java
java/server/trunk/src/org/red5/io/flv/meta/Resolver.java
java/server/trunk/src/org/red5/io/mock/Input.java
java/server/trunk/src/org/red5/io/mock/Output.java
java/server/trunk/src/org/red5/io/mp3/impl/MP3.java
java/server/trunk/src/org/red5/io/mp3/impl/MP3Header.java
java/server/trunk/src/org/red5/io/mp3/impl/MP3Reader.java
java/server/trunk/src/org/red5/io/mp3/impl/MP3Service.java
java/server/trunk/src/org/red5/io/object/BaseOutput.java
java/server/trunk/src/org/red5/io/object/DataTypes.java
java/server/trunk/src/org/red5/io/object/Deserializer.java
java/server/trunk/src/org/red5/io/object/Input.java
java/server/trunk/src/org/red5/io/object/Output.java
java/server/trunk/src/org/red5/io/object/RecordSet.java
java/server/trunk/src/org/red5/io/object/RecordSetPage.java
java/server/trunk/src/org/red5/io/object/Serializer.java
java/server/trunk/src/org/red5/io/utils/DOM2Writer.java
java/server/trunk/src/org/red5/io/utils/XMLUtils.java
java/server/trunk/src/org/red5/samples/client/SimpleClient.java
java/server/trunk/src/org/red5/samples/services/EchoService.java
java/server/trunk/src/org/red5/server/Standalone.java
java/server/trunk/src/org/red5/server/api/IBandwidthConfigure.java
java/server/trunk/src/org/red5/server/api/scheduling/IScheduledJob.java
java/server/trunk/src/org/red5/server/api/service/IPendingServiceCall.java
java/server/trunk/src/org/red5/server/api/stream/IStreamCapableConnection.java
java/server/trunk/src/org/red5/server/api/stream/IStreamCodecInfo.java
java/server/trunk/src/org/red5/server/api/stream/support/SimpleBandwidthConfigure.java
java/server/trunk/src/org/red5/server/messaging/IFilter.java
java/server/trunk/src/org/red5/server/messaging/IMessage.java
java/server/trunk/src/org/red5/server/messaging/IMessageComponent.java
java/server/trunk/src/org/red5/server/messaging/IMessageInput.java
java/server/trunk/src/org/red5/server/messaging/PipeUtils.java
java/server/trunk/src/org/red5/server/net/IConnectionEventQueue.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/protocol/SimpleProtocolCodecFactory.java
java/server/trunk/src/org/red5/server/net/protocol/SimpleProtocolDecoder.java
java/server/trunk/src/org/red5/server/net/protocol/SimpleProtocolEncoder.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/IRemotingCallback.java
java/server/trunk/src/org/red5/server/net/remoting/RemotingClient.java
java/server/trunk/src/org/red5/server/net/remoting/RemotingHeader.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/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/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/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/FlexMessage.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/Constants.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/message/SharedObjectTypeMapping.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/StatusCodes.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/rtmpt/codec/RTMPTProtocolDecoder.java
java/server/trunk/src/org/red5/server/net/rtmpt/codec/RTMPTProtocolEncoder.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/persistence/FilePersistence.java
java/server/trunk/src/org/red5/server/persistence/RamPersistence.java
java/server/trunk/src/org/red5/server/script/bsh/BshScriptFactory.java
java/server/trunk/src/org/red5/server/script/bsh/BshScriptUtils.java
java/server/trunk/src/org/red5/server/script/groovy/GroovyScriptFactory.java
java/server/trunk/src/org/red5/server/script/jruby/JRubyScriptFactory.java
java/server/trunk/src/org/red5/server/script/jython/JythonScriptFactory.java
java/server/trunk/src/org/red5/server/script/rhino/RhinoScriptFactory.java
java/server/trunk/src/org/red5/server/script/rhino/RhinoScriptUtils.java
java/server/trunk/src/org/red5/server/stream/ClientBroadcastStream.java
java/server/trunk/src/org/red5/server/stream/FileStreamSource.java
java/server/trunk/src/org/red5/server/stream/IFrameDropper.java
java/server/trunk/src/org/red5/server/stream/ISeekableProvider.java
java/server/trunk/src/org/red5/server/stream/IStreamData.java
java/server/trunk/src/org/red5/server/stream/IStreamFlow.java
java/server/trunk/src/org/red5/server/stream/IStreamSource.java
java/server/trunk/src/org/red5/server/stream/ITokenBucket.java
java/server/trunk/src/org/red5/server/stream/ITokenBucketService.java
java/server/trunk/src/org/red5/server/stream/OutputStream.java
java/server/trunk/src/org/red5/server/stream/PlayBuffer.java
java/server/trunk/src/org/red5/server/stream/PlaylistSubscriberStream.java
java/server/trunk/src/org/red5/server/stream/ServerStream.java
java/server/trunk/src/org/red5/server/stream/SimpleFlowControlService.java
java/server/trunk/src/org/red5/server/stream/SimplePlaylistController.java
java/server/trunk/src/org/red5/server/stream/StreamFlow.java
java/server/trunk/src/org/red5/server/stream/StreamFlowController.java
java/server/trunk/src/org/red5/server/stream/StreamService.java
java/server/trunk/src/org/red5/server/stream/StreamTracker.java
java/server/trunk/src/org/red5/server/stream/TokenBucket.java
java/server/trunk/src/org/red5/server/stream/VideoCodecFactory.java
java/server/trunk/src/org/red5/server/stream/codec/ScreenVideo.java
java/server/trunk/src/org/red5/server/stream/codec/SorensonVideo.java
java/server/trunk/src/org/red5/server/stream/codec/StreamCodecInfo.java
java/server/trunk/src/org/red5/server/stream/consumer/ConnectionConsumer.java
java/server/trunk/src/org/red5/server/stream/filter/StreamBandwidthController.java
java/server/trunk/src/org/red5/server/stream/message/RTMPMessage.java
java/server/trunk/src/org/red5/server/stream/provider/ConnectionProvider.java
java/server/trunk/src/org/red5/server/stream/provider/FileProvider.java
java/server/trunk/test/org/red5/server/api/test/SharedObjectTest.java
java/server/trunk/test/org/red5/server/api/test/TestConnection.java
java/server/trunk/test/org/red5/server/io/test/AMFIOTest.java
java/server/trunk/test/org/red5/server/io/test/AbstractIOTest.java
java/server/trunk/test/org/red5/server/io/test/CircularRefBean.java
java/server/trunk/test/org/red5/server/io/test/FLVServiceImplTest.java
java/server/trunk/test/org/red5/server/io/test/MetaDataTest.java
java/server/trunk/test/org/red5/server/io/test/MetaServiceTest.java
java/server/trunk/test/org/red5/server/io/test/MockIOTest.java
java/server/trunk/test/org/red5/server/io/test/SimpleJavaBean.java
java/server/trunk/test/org/red5/server/io/test/TestJavaBean.java
java/server/trunk/test/org/red5/server/rtmp/test/RTMPTestCase.java
java/server/trunk/test/org/red5/server/service/test/ServiceInvokerTest.java
java/server/trunk/test/org/red5/server/service/test/TestEchoService.java
java/server/trunk/webapps/fitcDemo/WEB-INF/src/org/red5/demos/fitc/Application.java
java/server/trunk/webapps/midiDemo/WEB-INF/src/org/red5/demos/midi/Application.java
java/server/trunk/webapps/oflaDemo/WEB-INF/src/org/red5/server/webapp/oflaDemo/Application.java
java/server/trunk/webapps/oflaDemo/WEB-INF/src/org/red5/server/webapp/oflaDemo/DemoService.java
java/server/trunk/webapps/oflaDemo/WEB-INF/src/org/red5/server/webapp/oflaDemo/DemoServiceImpl.java
java/server/trunk/webapps/oflaDemo/WEB-INF/src/org/red5/server/webapp/oflaDemo/IDemoService.java
java/server/trunk/webapps/test/WEB-INF/src/org/red5/server/performance/ThreadDumpBean.java
java/server/trunk/webapps/tutorial/WEB-INF/src/org/red5/tutorials/clientlist/Application.java
Trac: http://mirror1.cvsdude.com/trac/osflash/red5/changeset/1606
Index: /java/server/trunk/test/org/red5/server/service/test/TestEchoService.java
===================================================================
--- /java/server/trunk/test/org/red5/server/service/test/TestEchoService.java (revision 1406)
+++ /java/server/trunk/test/org/red5/server/service/test/TestEchoService.java (revision 1606)
@@ -49,5 +49,6 @@
private IEchoService echoService;
- @Override
+ /** {@inheritDoc} */
+ @Override
protected void setUp() throws Exception {
super.setUp();
@@ -55,5 +56,6 @@
}
- @Override
+ /** {@inheritDoc} */
+ @Override
protected void tearDown() throws Exception {
super.tearDown();
Index: /java/server/trunk/test/org/red5/server/service/test/ServiceInvokerTest.java
===================================================================
--- /java/server/trunk/test/org/red5/server/service/test/ServiceInvokerTest.java (revision 1406)
+++ /java/server/trunk/test/org/red5/server/service/test/ServiceInvokerTest.java (revision 1606)
@@ -47,5 +47,6 @@
protected ApplicationContext appCtx = null;
- @Override
+ /** {@inheritDoc} */
+ @Override
protected void setUp() throws Exception {
// TODO Auto-generated method stub
@@ -90,5 +91,6 @@
}
- @Override
+ /** {@inheritDoc} */
+ @Override
protected void tearDown() throws Exception {
// TODO Auto-generated method stub
Index: /java/server/trunk/test/org/red5/server/rtmp/test/RTMPTestCase.java
===================================================================
--- /java/server/trunk/test/org/red5/server/rtmp/test/RTMPTestCase.java (revision 1406)
+++ /java/server/trunk/test/org/red5/server/rtmp/test/RTMPTestCase.java (revision 1606)
@@ -27,5 +27,6 @@
protected RTMPProtocolDecoder decoder;
- @Override
+ /** {@inheritDoc} */
+ @Override
protected void setUp() throws Exception {
// TODO Auto-generated method stub
Index: /java/server/trunk/test/org/red5/server/io/test/MetaDataTest.java
===================================================================
--- /java/server/trunk/test/org/red5/server/io/test/MetaDataTest.java (revision 581)
+++ /java/server/trunk/test/org/red5/server/io/test/MetaDataTest.java (revision 1606)
@@ -39,9 +39,11 @@
MetaData data;
- public MetaDataTest() {
+ /** Constructs a new MetaDataTest. */
+ public MetaDataTest() {
data = new MetaData();
}
- protected void setUp() throws Exception {
+ /** {@inheritDoc} */
+ protected void setUp() throws Exception {
super.setUp();
@@ -55,5 +57,6 @@
}
- public void tearDown() {
+ /** {@inheritDoc} */
+ public void tearDown() {
data = null;
}
Index: /java/server/trunk/test/org/red5/server/io/test/MockIOTest.java
===================================================================
--- /java/server/trunk/test/org/red5/server/io/test/MockIOTest.java (revision 228)
+++ /java/server/trunk/test/org/red5/server/io/test/MockIOTest.java (revision 1606)
@@ -34,5 +34,6 @@
protected List list;
- void setupIO() {
+ /** {@inheritDoc} */
+ void setupIO() {
list = new LinkedList();
in = new Input(list);
@@ -40,9 +41,11 @@
}
- void dumpOutput() {
+ /** {@inheritDoc} */
+ void dumpOutput() {
System.out.println(Mock.listToString(list));
}
- void resetOutput() {
+ /** {@inheritDoc} */
+ void resetOutput() {
setupIO();
}
Index: /java/server/trunk/test/org/red5/server/io/test/SimpleJavaBean.java
===================================================================
--- /java/server/trunk/test/org/red5/server/io/test/SimpleJavaBean.java (revision 205)
+++ /java/server/trunk/test/org/red5/server/io/test/SimpleJavaBean.java (revision 1606)
@@ -27,16 +27,27 @@
private String nameOfBean = "jeff";
- public String getNameOfBean() {
+ /**
+ * Getter for property 'nameOfBean'.
+ *
+ * @return Value for property 'nameOfBean'.
+ */
+ public String getNameOfBean() {
return nameOfBean;
}
- public void setNameOfBean(String nameOfBean) {
+ /**
+ * Setter for property 'nameOfBean'.
+ *
+ * @param nameOfBean Value to set for property 'nameOfBean'.
+ */
+ public void setNameOfBean(String nameOfBean) {
this.nameOfBean = nameOfBean;
}
- public boolean equals(Object obj){
+ /** {@inheritDoc} */
+ public boolean equals(Object obj){
if(obj instanceof SimpleJavaBean){
SimpleJavaBean sjb = (SimpleJavaBean) obj;
- return sjb.getNameOfBean() == sjb.getNameOfBean();
+ return sjb.getNameOfBean().equals(sjb.getNameOfBean());
}
return false;
Index: /java/server/trunk/test/org/red5/server/io/test/CircularRefBean.java
===================================================================
--- /java/server/trunk/test/org/red5/server/io/test/CircularRefBean.java (revision 205)
+++ /java/server/trunk/test/org/red5/server/io/test/CircularRefBean.java (revision 1606)
@@ -27,13 +27,24 @@
private CircularRefBean refToSelf;
- public CircularRefBean(){
+ /** Constructs a new CircularRefBean. */
+ public CircularRefBean(){
super();
}
- public CircularRefBean getRefToSelf() {
+ /**
+ * Getter for property 'refToSelf'.
+ *
+ * @return Value for property 'refToSelf'.
+ */
+ public CircularRefBean getRefToSelf() {
return refToSelf;
}
- public void setRefToSelf(CircularRefBean refToSelf) {
+ /**
+ * Setter for property 'refToSelf'.
+ *
+ * @param refToSelf Value to set for property 'refToSelf'.
+ */
+ public void setRefToSelf(CircularRefBean refToSelf) {
this.refToSelf = refToSelf;
}
Index: /java/server/trunk/test/org/red5/server/io/test/MetaServiceTest.java
===================================================================
--- /java/server/trunk/test/org/red5/server/io/test/MetaServiceTest.java (revision 1565)
+++ /java/server/trunk/test/org/red5/server/io/test/MetaServiceTest.java (revision 1606)
@@ -25,5 +25,6 @@
private MetaService metaService;
- protected void setUp() throws Exception {
+ /** {@inheritDoc} */
+ protected void setUp() throws Exception {
super.setUp();
Index: /java/server/trunk/test/org/red5/server/io/test/TestJavaBean.java
===================================================================
--- /java/server/trunk/test/org/red5/server/io/test/TestJavaBean.java (revision 205)
+++ /java/server/trunk/test/org/red5/server/io/test/TestJavaBean.java (revision 1606)
@@ -35,44 +35,114 @@
private boolean testBoolean = true;
- public byte getTestByte() {
+ /**
+ * Getter for property 'testByte'.
+ *
+ * @return Value for property 'testByte'.
+ */
+ public byte getTestByte() {
return testByte;
}
- public void setTestByte(byte testByte) {
+ /**
+ * Setter for property 'testByte'.
+ *
+ * @param testByte Value to set for property 'testByte'.
+ */
+ public void setTestByte(byte testByte) {
this.testByte = testByte;
}
- public boolean isTestBoolean() {
+ /**
+ * Getter for property 'testBoolean'.
+ *
+ * @return Value for property 'testBoolean'.
+ */
+ public boolean isTestBoolean() {
return testBoolean;
}
- public void setTestBoolean(boolean testBoolean) {
+ /**
+ * Setter for property 'testBoolean'.
+ *
+ * @param testBoolean Value to set for property 'testBoolean'.
+ */
+ public void setTestBoolean(boolean testBoolean) {
this.testBoolean = testBoolean;
}
- public Boolean getTestBooleanObject() {
+ /**
+ * Getter for property 'testBooleanObject'.
+ *
+ * @return Value for property 'testBooleanObject'.
+ */
+ public Boolean getTestBooleanObject() {
return testBooleanObject;
}
- public void setTestBooleanObject(Boolean testBooleanObject) {
+ /**
+ * Setter for property 'testBooleanObject'.
+ *
+ * @param testBooleanObject Value to set for property 'testBooleanObject'.
+ */
+ public void setTestBooleanObject(Boolean testBooleanObject) {
this.testBooleanObject = testBooleanObject;
}
- public Date getTestDate() {
+ /**
+ * Getter for property 'testDate'.
+ *
+ * @return Value for property 'testDate'.
+ */
+ public Date getTestDate() {
return testDate;
}
- public void setTestDate(Date testDate) {
+ /**
+ * Setter for property 'testDate'.
+ *
+ * @param testDate Value to set for property 'testDate'.
+ */
+ public void setTestDate(Date testDate) {
this.testDate = testDate;
}
- public Integer getTestNumberObject() {
+ /**
+ * Getter for property 'testNumberObject'.
+ *
+ * @return Value for property 'testNumberObject'.
+ */
+ public Integer getTestNumberObject() {
return testNumberObject;
}
- public void setTestNumberObject(Integer testNumberObject) {
+ /**
+ * Setter for property 'testNumberObject'.
+ *
+ * @param testNumberObject Value to set for property 'testNumberObject'.
+ */
+ public void setTestNumberObject(Integer testNumberObject) {
this.testNumberObject = testNumberObject;
}
- public int getTestPrimitiveNumber() {
+ /**
+ * Getter for property 'testPrimitiveNumber'.
+ *
+ * @return Value for property 'testPrimitiveNumber'.
+ */
+ public int getTestPrimitiveNumber() {
return testPrimitiveNumber;
}
- public void setTestPrimitiveNumber(int testPrimitiveNumber) {
+ /**
+ * Setter for property 'testPrimitiveNumber'.
+ *
+ * @param testPrimitiveNumber Value to set for property 'testPrimitiveNumber'.
+ */
+ public void setTestPrimitiveNumber(int testPrimitiveNumber) {
this.testPrimitiveNumber = testPrimitiveNumber;
}
- public String getTestString() {
+ /**
+ * Getter for property 'testString'.
+ *
+ * @return Value for property 'testString'.
+ */
+ public String getTestString() {
return testString;
}
- public void setTestString(String testString) {
+ /**
+ * Setter for property 'testString'.
+ *
+ * @param testString Value to set for property 'testString'.
+ */
+ public void setTestString(String testString) {
this.testString = testString;
}
Index: /java/server/trunk/test/org/red5/server/io/test/FLVServiceImplTest.java
===================================================================
--- /java/server/trunk/test/org/red5/server/io/test/FLVServiceImplTest.java (revision 1590)
+++ /java/server/trunk/test/org/red5/server/io/test/FLVServiceImplTest.java (revision 1606)
@@ -24,10 +24,5 @@
*/
-import java.io.File;
-import java.io.FileInputStream;
-import java.io.FileNotFoundException;
-import java.io.FileOutputStream;
-import java.io.IOException;
-import java.io.RandomAccessFile;
+import java.io.*;
import java.util.HashMap;
import java.util.Map;
@@ -77,5 +72,10 @@
* @return void
* @throws IOException
+<<<<<<< .mine
* @throws FileNotFoundException
+ * @param tag
+=======
+ * @throws FileNotFoundException
+>>>>>>> .r1592
*/
/*
@@ -151,12 +151,9 @@
/**
* Tests: getFLVFileInputStream(FileInputStream fis)
- * @param writer
- * @param reader
- * @return void
- * @throws IOException
- * @throws FileNotFoundException
- */
- /*
- public void testFLVFileInputStream() throws FileNotFoundException, IOException {
+ * @return void
+ * @throws IOException
+ */
+ /*
+ public void testFLVFileInputStream() throws FileNotFoundException, IOException {
File f = new File("tests/test_cue3.flv");
FileInputStream fis = new FileInputStream(f);
Index: /java/server/trunk/test/org/red5/server/io/test/AMFIOTest.java
===================================================================
--- /java/server/trunk/test/org/red5/server/io/test/AMFIOTest.java (revision 228)
+++ /java/server/trunk/test/org/red5/server/io/test/AMFIOTest.java (revision 1606)
@@ -32,5 +32,6 @@
ByteBuffer buf;
- void setupIO() {
+ /** {@inheritDoc} */
+ void setupIO() {
buf = ByteBuffer.allocate(0); // 1kb
buf.setAutoExpand(true);
@@ -39,10 +40,12 @@
}
- void dumpOutput() {
+ /** {@inheritDoc} */
+ void dumpOutput() {
buf.flip();
System.err.println(HexDump.formatHexDump(buf.getHexDump()));
}
- void resetOutput() {
+ /** {@inheritDoc} */
+ void resetOutput() {
setupIO();
}
Index: /java/server/trunk/test/org/red5/server/io/test/AbstractIOTest.java
===================================================================
--- /java/server/trunk/test/org/red5/server/io/test/AbstractIOTest.java (revision 228)
+++ /java/server/trunk/test/org/red5/server/io/test/AbstractIOTest.java (revision 1606)
@@ -52,5 +52,6 @@
protected Output out;
- protected void setUp(){
+ /** {@inheritDoc} */
+ protected void setUp(){
serializer = new Serializer();
deserializer = new Deserializer();
Index: /java/server/trunk/test/org/red5/server/api/test/TestConnection.java
===================================================================
--- /java/server/trunk/test/org/red5/server/api/test/TestConnection.java (revision 1596)
+++ /java/server/trunk/test/org/red5/server/api/test/TestConnection.java (revision 1606)
@@ -9,8 +9,12 @@
}
+ /**
+ * Return encoding (currently AMF0)
+ * @return AMF0 encoding constant
+ */
public Encoding getEncoding() {
return Encoding.AMF0;
}
-
+ /** {@inheritDoc} */
@Override
public long getReadBytes() {
@@ -18,14 +22,17 @@
}
- @Override
+ /** {@inheritDoc} */
+ @Override
public long getWrittenBytes() {
return 0;
}
- public void ping() {
+ /** {@inheritDoc} */
+ public void ping() {
}
- public int getLastPingTime() {
+ /** {@inheritDoc} */
+ public int getLastPingTime() {
return 0;
}
Index: /java/server/trunk/test/org/red5/server/api/test/SharedObjectTest.java
===================================================================
--- /java/server/trunk/test/org/red5/server/api/test/SharedObjectTest.java (revision 1406)
+++ /java/server/trunk/test/org/red5/server/api/test/SharedObjectTest.java (revision 1606)
@@ -31,5 +31,6 @@
}
- public void notifyEvent(IEvent event) {
+ /** {@inheritDoc} */
+ public void notifyEvent(IEvent event) {
log.debug("Event: " + event);
}
Index: /java/server/trunk/src/org/red5/samples/services/EchoService.java
===================================================================
--- /java/server/trunk/src/org/red5/samples/services/EchoService.java (revision 1406)
+++ /java/server/trunk/src/org/red5/samples/services/EchoService.java (revision 1606)
@@ -42,5 +42,6 @@
private Log log = LogFactory.getLog(EchoService.class.getName());
- public void startUp() {
+ /** {@inheritDoc} */
+ public void startUp() {
log.info("The Echo Service has started...");
}
Index: /java/server/trunk/src/org/red5/samples/client/SimpleClient.java
===================================================================
--- /java/server/trunk/src/org/red5/samples/client/SimpleClient.java (revision 1531)
+++ /java/server/trunk/src/org/red5/samples/client/SimpleClient.java (revision 1606)
@@ -43,5 +43,6 @@
}
- public void connectionOpened(RTMPConnection conn, RTMP state) {
+ /** {@inheritDoc} */
+ public void connectionOpened(RTMPConnection conn, RTMP state) {
System.out.println("opened");
Channel channel=conn.getChannel((byte)3);
@@ -63,5 +64,6 @@
}
- public void messageReceived(RTMPConnection conn, ProtocolState state, Object message) throws Exception {
+ /** {@inheritDoc} */
+ public void messageReceived(RTMPConnection conn, ProtocolState state, Object message) throws Exception {
System.out.println("message received "+message);
if(message instanceof Packet) {
@@ -71,10 +73,12 @@
}
- public void messageSent(RTMPConnection conn, Object message) {
+ /** {@inheritDoc} */
+ public void messageSent(RTMPConnection conn, Object message) {
System.out.println("message sent "+message);
}
- public void connectionClosed(RTMPConnection conn, RTMP state) {
+ /** {@inheritDoc} */
+ public void connectionClosed(RTMPConnection conn, RTMP state) {
System.out.println("connection closed");
Index: /java/server/trunk/src/org/red5/server/persistence/FilePersistence.java
===================================================================
--- /java/server/trunk/src/org/red5/server/persistence/FilePersistence.java (revision 1597)
+++ /java/server/trunk/src/org/red5/server/persistence/FilePersistence.java (revision 1606)
@@ -20,12 +20,4 @@
*/
-import java.io.File;
-import java.io.FileInputStream;
-import java.io.FileNotFoundException;
-import java.io.FileOutputStream;
-import java.io.IOException;
-import java.lang.reflect.Constructor;
-import java.lang.reflect.InvocationTargetException;
-
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
@@ -40,6 +32,10 @@
import org.springframework.core.io.support.ResourcePatternResolver;
+import java.io.*;
+import java.lang.reflect.Constructor;
+import java.lang.reflect.InvocationTargetException;
+
/**
- * Simple file-based persistence for objects.
+ * Simple file-based persistence for objects. Lowers memory usage if used instead of RAM memoty storage.
*
* @author The Red5 Project (red5 at osflash.org)
@@ -49,21 +45,41 @@
public class FilePersistence extends RamPersistence {
- private Log log = LogFactory.getLog(FilePersistence.class.getName());
-
+ /**
+ * Logger
+ */
+ private Log log = LogFactory.getLog(FilePersistence.class.getName());
+ /**
+ * Files path
+ */
private String path = "persistence";
-
+ /**
+ * Root directory under file storage path
+ */
private String rootDir = "";
-
+ /**
+ * File extension for persistent objects
+ */
private String extension = ".red5";
- // TODO: make this configurable
+ /**
+ * Whether there's ned to check for empty directories
+ */
+ // TODO: make this configurable
private boolean checkForEmptyDirectories = true;
- public FilePersistence(ResourcePatternResolver resolver) {
+ /**
+ * Create file persistence object from given resource pattern resolver
+ * @param resolver Resource pattern resolver and loader
+ */
+ public FilePersistence(ResourcePatternResolver resolver) {
super(resolver);
setPath(path);
}
- public FilePersistence(IScope scope) {
+ /**
+ * Create file persistence object for given scope
+ * @param scope Scope
+ */
+ public FilePersistence(IScope scope) {
super(scope);
setPath(path);
@@ -71,23 +87,23 @@
/**
- * Setter for property 'path'.
+ * Setter for file path.
*
- * @param path Value to set for property 'path'.
+ * @param path New path
*/
public void setPath(String path) {
- this.path = path;
-
Resource rootFile = resources.getResource(path);
try {
rootDir = rootFile.getFile().getAbsolutePath();
- } catch (IOException err) {
- return;
+ this.path = path;
+ } catch (IOException err) {
+ log.error("I/O exception thrown when setting file path to " + path);
+ throw (new RuntimeException(err));
}
}
/**
- * Setter for property 'extension'.
+ * Setter for extension.
*
- * @param extension Value to set for property 'extension'.
+ * @param extension New extension.
*/
public void setExtension(String extension) {
@@ -95,9 +111,20 @@
}
+ /**
+ * Return file path for persistable object
+ * @param object Object to obtain file path for
+ * @return Path on disk
+ */
private String getObjectFilepath(IPersistable object) {
return getObjectFilepath(object, false);
}
- private String getObjectFilepath(IPersistable object, boolean completePath) {
+ /**
+ * Return file path for persistable object
+ * @param object Object to obtain file path for
+ * @param completePath Whether it full path full path sould be returned
+ * @return Path on disk
+ */
+ private String getObjectFilepath(IPersistable object, boolean completePath) {
String result = path + '/' + object.getType() + '/' + object.getPath();
if (!result.endsWith("/")) {
@@ -125,4 +152,9 @@
}
+ /**
+ * Get filename for persistable object
+ * @param object Persistable object
+ * @return Name of file where given object is persisted to
+ */
private String getObjectFilename(IPersistable object) {
String path = getObjectFilepath(object);
@@ -134,9 +166,20 @@
}
- private IPersistable doLoad(String name) {
+ /**
+ * Load resource with given name
+ * @param name Resource name
+ * @return Persistable object
+ */
+ private IPersistable doLoad(String name) {
return doLoad(name, null);
}
- private IPersistable doLoad(String name, IPersistable object) {
+ /**
+ * Load resource with given name and attaches to persistable object
+ * @param name Resource name
+ * @param object Object to attach to
+ * @return Persistable object
+ */
+ private IPersistable doLoad(String name, IPersistable object) {
IPersistable result = object;
Resource data = resources.getResource(name);
@@ -182,8 +225,6 @@
// Try to create object by calling constructor with Input stream as
// parameter.
- for (Class interfaceClass : in.getClass()
- .getInterfaces()) {
- constructor = theClass
- .getConstructor(new Class[] { interfaceClass });
+ for (Class interfaceClass : in.getClass().getInterfaces()) {
+ constructor = theClass.getConstructor(new Class[] { interfaceClass });
if (constructor != null) {
break;
@@ -194,6 +235,5 @@
}
- result = (IPersistable) constructor
- .newInstance(new Object[] { in });
+ result = (IPersistable) constructor.newInstance(new Object[] { in });
} catch (NoSuchMethodException err) {
// No valid constructor found, use empty
@@ -273,5 +313,10 @@
}
- private boolean saveObject(IPersistable object) {
+ /**
+ * Save persistable object
+ * @param object Persistable object
+ * @return <code>true</code> on success, <code>false</code> otherwise
+ */
+ private boolean saveObject(IPersistable object) {
String path = getObjectFilepath(object, true);
Resource resPath = resources.getResource(path);
@@ -329,5 +374,9 @@
}
- protected void checkRemoveEmptyDirectories(String base) {
+ /**
+ * Remove empty dirs
+ * @param base Base directory
+ */
+ protected void checkRemoveEmptyDirectories(String base) {
if (!checkForEmptyDirectories) {
return;
Index: /java/server/trunk/src/org/red5/server/persistence/RamPersistence.java
===================================================================
--- /java/server/trunk/src/org/red5/server/persistence/RamPersistence.java (revision 1597)
+++ /java/server/trunk/src/org/red5/server/persistence/RamPersistence.java (revision 1606)
@@ -20,8 +20,4 @@
*/
-import java.util.HashMap;
-import java.util.Iterator;
-import java.util.Map;
-
import org.red5.server.api.IScope;
import org.red5.server.api.ScopeUtils;
@@ -29,4 +25,8 @@
import org.red5.server.api.persistence.IPersistenceStore;
import org.springframework.core.io.support.ResourcePatternResolver;
+
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
/**
@@ -42,17 +42,36 @@
protected static final String PERSISTENCE_NO_NAME = "__null__";
- protected Map<String, IPersistable> objects = new HashMap<String, IPersistable>();
+ /**
+ * Map for persistable objects
+ */
+ protected Map<String, IPersistable> objects = new HashMap<String, IPersistable>();
- protected ResourcePatternResolver resources;
+ /**
+ * Resource pattern resolver. Resolves resources from patterns, loads resources.
+ */
+ protected ResourcePatternResolver resources;
- public RamPersistence(ResourcePatternResolver resources) {
+ /**
+ * Creates RAM persistence object from resource pattern resolvers
+ * @param resources Resource pattern resolver and loader
+ */
+ public RamPersistence(ResourcePatternResolver resources) {
this.resources = resources;
}
+ /**
+ * Creates RAM persistence ob
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