Package org.apache.hadoop.ipc

Class ProtocolSignature

java.lang.Object

org.apache.hadoop.ipc.ProtocolSignature

All Implemented Interfaces:

Writable

public class ProtocolSignature
extends java.lang.Object
implements Writable

Constructor Summary

Constructors

Constructor	Description
ProtocolSignature()	default constructor
ProtocolSignature(long version, int[] methodHashcodes)	Constructor

Method Summary

Modifier and Type	Method	Description
int[]	getMethods()
static ProtocolSignature	getProtocolSignature(int clientMethodsHashCode, long serverVersion, java.lang.Class<? extends VersionedProtocol> protocol)	Get a server protocol's signature
static ProtocolSignature	getProtocolSignature(java.lang.String protocolName, long version)
static ProtocolSignature	getProtocolSignature(VersionedProtocol server, java.lang.String protocol, long clientVersion, int clientMethodsHash)	Get a server protocol's signature
long	getVersion()
void	readFields(java.io.DataInput in)	Deserialize the fields of this object from in.
static void	resetCache()
void	write(java.io.DataOutput out)	Serialize the fields of this object to out.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProtocolSignature

public ProtocolSignature()

default constructor

ProtocolSignature

public ProtocolSignature(long version,
                         int[] methodHashcodes)

Constructor

Parameters:

version - server version

methodHashcodes - hash codes of the methods supported by server

Method Detail

getVersion

public long getVersion()

getMethods

public int[] getMethods()

readFields

public void readFields(java.io.DataInput in)
                throws java.io.IOException

Description copied from interface: Writable

Deserialize the fields of this object from in.

For efficiency, implementations should attempt to re-use storage in the existing object where possible.

Specified by:

readFields in interface Writable

Parameters:

in - DataInput to deseriablize this object from.

Throws:

java.io.IOException - any other problem for readFields.

write

public void write(java.io.DataOutput out)
           throws java.io.IOException

Description copied from interface: Writable

Serialize the fields of this object to out.

Specified by:

write in interface Writable

Parameters:

out - DataOuput to serialize this object into.

Throws:

java.io.IOException - any other problem for write.

resetCache

@VisibleForTesting
public static void resetCache()

getProtocolSignature

public static ProtocolSignature getProtocolSignature(int clientMethodsHashCode,
                                                     long serverVersion,
                                                     java.lang.Class<? extends VersionedProtocol> protocol)

Get a server protocol's signature

Parameters:

clientMethodsHashCode - client protocol methods hashcode

serverVersion - server protocol version

protocol - protocol

Returns:

the server's protocol signature

getProtocolSignature

public static ProtocolSignature getProtocolSignature(java.lang.String protocolName,
                                                     long version)
                                              throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException

getProtocolSignature

public static ProtocolSignature getProtocolSignature(VersionedProtocol server,
                                                     java.lang.String protocol,
                                                     long clientVersion,
                                                     int clientMethodsHash)
                                              throws java.io.IOException

Get a server protocol's signature

Parameters:

server - server implementation

protocol - server protocol

clientVersion - client's version

clientMethodsHash - client's protocol's hash code

Returns:

the server protocol's signature

Throws:

java.io.IOException - if any error occurs