Interface ISerializer
-
public interface ISerializer
- Since:
- Mar 8, 2006
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
HANDSHAKE_CLIENT_ID
key used in handshake dictionarystatic java.lang.String
HANDSHAKE_PROCESS_ID
key used in handshake dictionarystatic java.lang.String
HANDSHAKE_PROTO
key used in handshake dictionarystatic java.lang.String
HANDSHAKE_VERSION
key used in handshake dictionary
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
dispose(boolean sendShutdownMessage)
Close the internal input/output streamsISerializer
flush()
Flush buffered data if anyNCMap
handshake()
boolean
isValid()
Returns true if the ISerializer object is validNCType
read()
Reads aNCType
object from a DataInput.ISerializer
write(NCType val)
Writes anNCType
object to a DataOutput.
-
-
-
Field Detail
-
HANDSHAKE_VERSION
static final java.lang.String HANDSHAKE_VERSION
key used in handshake dictionary- See Also:
- Constant Field Values
-
HANDSHAKE_PROTO
static final java.lang.String HANDSHAKE_PROTO
key used in handshake dictionary- See Also:
- Constant Field Values
-
HANDSHAKE_CLIENT_ID
static final java.lang.String HANDSHAKE_CLIENT_ID
key used in handshake dictionary- See Also:
- Constant Field Values
-
HANDSHAKE_PROCESS_ID
static final java.lang.String HANDSHAKE_PROCESS_ID
key used in handshake dictionary- See Also:
- Constant Field Values
-
-
Method Detail
-
handshake
NCMap handshake()
- Returns:
- the handshake dictionary
-
read
NCType read() throws java.io.IOException
Reads aNCType
object from a DataInput.- Returns:
- a
NCType
object from the specified DataInput - Throws:
java.io.IOException
- on I/O failure
-
write
ISerializer write(NCType val) throws java.io.IOException
Writes anNCType
object to a DataOutput.- Parameters:
val
- NCType to write- Returns:
- the Serializer
- Throws:
java.io.IOException
- on I/O failure
-
flush
ISerializer flush() throws java.io.IOException
Flush buffered data if any- Returns:
- the Serializer
- Throws:
java.io.IOException
- on error
-
isValid
boolean isValid()
Returns true if the ISerializer object is valid- Returns:
- true if the ISerializer object is valid
-
dispose
void dispose(boolean sendShutdownMessage)
Close the internal input/output streams- Parameters:
sendShutdownMessage
- - if true sends a shutdown message before disposal
-
-