From b879f0fcc8651b49ae46a6db64d7eb1a27c7af1a Mon Sep 17 00:00:00 2001 From: Silvio Date: Fri, 20 Aug 2010 15:39:56 -0300 Subject: Adding generated docs --- .../classorg_1_1openisis_1_1PlainSerializer.html | 412 +++++++++++++++++++++ 1 file changed, 412 insertions(+) create mode 100644 doc/html/classorg_1_1openisis_1_1PlainSerializer.html (limited to 'doc/html/classorg_1_1openisis_1_1PlainSerializer.html') diff --git a/doc/html/classorg_1_1openisis_1_1PlainSerializer.html b/doc/html/classorg_1_1openisis_1_1PlainSerializer.html new file mode 100644 index 0000000..f6b1148 --- /dev/null +++ b/doc/html/classorg_1_1openisis_1_1PlainSerializer.html @@ -0,0 +1,412 @@ + + + + + +IsisReader: org::openisis::PlainSerializer Class Reference + + + + + + + + + +
+

org::openisis::PlainSerializer Class Reference

+

List of all members.

+ + + + + + + + + + + + + + + + + + + +

Classes

class  ByteBuf
class  ProtocolViolation
class  PSWriter

Public Member Functions

boolean flush ()
boolean write (Field fld)
boolean write (Field[] flds)
Field[] read ()
+void setBinaryMode (boolean bin)
void setEncoding (String enc)
 PlainSerializer (InputStream in, OutputStream out, String enc, boolean bin)
 PlainSerializer (InputStream in, OutputStream out)
 PlainSerializer (String hostname, int port, String enc, boolean bin) throws Exception
 PlainSerializer (String hostname, int port) throws Exception
void close ()

Static Public Member Functions

static void main (String argv[])
+

Detailed Description

+

Serialization of fields by plain protocol.

+
Id
PlainSerializer.java,v 1.8 2003/05/02 18:41:55 mawag Exp
+
Version:
+
Revision
1.8
+
Author:
+
Author
mawag
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
org::openisis::PlainSerializer::PlainSerializer (InputStream  in,
OutputStream  out,
String  enc,
boolean  bin 
) [inline]
+
+
+

Constructor with read and write stream.

+
Parameters:
+ + + +
enc character encoding
bin binary mode
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
org::openisis::PlainSerializer::PlainSerializer (InputStream  in,
OutputStream  out 
) [inline]
+
+
+

Constructor using text mode and platforms default encoding.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
org::openisis::PlainSerializer::PlainSerializer (String  hostname,
int  port,
String  enc,
boolean  bin 
) throws Exception [inline]
+
+
+

Constructor for a socket connection to port.

+
Parameters:
+ + + +
enc character encoding
bin binary mode
+
+
+
Exceptions:
+ + +
all exceptions a socket might throw
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
org::openisis::PlainSerializer::PlainSerializer (String  hostname,
int  port 
) throws Exception [inline]
+
+
+

Constructor using text mode and platforms default encoding.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + +
void org::openisis::PlainSerializer::close ( )  [inline]
+
+
+

Close communication channels.

+ +
+
+ +
+
+ + + + + + + + +
boolean org::openisis::PlainSerializer::flush ( )  [inline]
+
+
+

write end of record to output stream.

+
Returns:
success
+ +
+
+ +
+
+ + + + + + + + + +
static void org::openisis::PlainSerializer::main (String  argv[] )  [inline, static]
+
+
+

Tester:
+

+
+		java org.openisis.PlainSerializer -p
+		java org.openisis.PlainSerializer -b -p
+		java org.openisis.PlainSerializer -e UTF-8 -p
+		java org.openisis.PlainSerializer -e UTF-8 -b -p
+		java org.openisis.PlainSerializer -e UTF-16 -p
+		java org.openisis.PlainSerializer -e UTF-16 -b -p
+		java org.openisis.PlainSerializer -p 55
+		java org.openisis.PlainSerializer -b -p 55
+		java org.openisis.PlainSerializer -e UTF-16 -p 55
+		java org.openisis.PlainSerializer -e UTF-16 -b -p 55
+
+
+
+ +
+
+ + + + + + + + +
Field [] org::openisis::PlainSerializer::read ( )  [inline]
+
+
+

deserialize fields.

+
Returns:
array of fields read from input stream, null on error
+ +
+
+ +
+
+ + + + + + + + + +
void org::openisis::PlainSerializer::setEncoding (String  enc )  [inline]
+
+
+

Set character encoding to use in subsequent calls to read and write.

+
Parameters:
+ + +
enc if null, the platforms default encoding will be used
+
+
+ +
+
+ +
+
+ + + + + + + + + +
boolean org::openisis::PlainSerializer::write (Field[]  flds )  [inline]
+
+
+

serialize fields.

+
Returns:
success
+ +
+
+ +
+
+ + + + + + + + + +
boolean org::openisis::PlainSerializer::write (Field  fld )  [inline]
+
+
+

serialize one field.

+
Returns:
success
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+ All Classes Namespaces Functions Variables
+ + +
+ +
+ +
Generated on Tue Mar 30 14:47:17 2010 for IsisReader by  + +doxygen 1.6.1
+ + -- cgit v1.2.3