[HDFS-16151] Improve the parameter comments related to ProtobufRpcEngine2#Server()

• Type: Bug
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 3.4.0, 3.3.2
• Component/s: documentation
• Labels: pull-request-available
• Hadoop Flags: Reviewed
• Assignee: JiangHua Zhu
• Reporter: JiangHua Zhu
• Created: 02/Aug/21 11:28
• Updated: 09/Aug/21 02:07
• Resolved: 08/Aug/21 05:58

Description

Now missing some parameter comments related to ProtobufRpcEngine2#Server(), as follows:
/**

• Construct an RPC server.
  *
• @param protocolClass the class of protocol
• @param protocolImpl the protocolImpl whose methods will be called
• @param conf the configuration to use
• @param bindAddress the address to bind on to listen for connection
• @param port the port to listen for connections on
• @param numHandlers the number of method handler threads to run
• @param verbose whether each call should be logged
• @param portRangeConfig A config parameter that can be used to restrict
• the range of ports used when port is 0 (an ephemeral port)
• @param alignmentContext provides server state info on client responses
  */
  public Server(Class<?> protocolClass, Object protocolImpl,
  Configuration conf, String bindAddress, int port, int numHandlers,
  int numReaders, int queueSizePerHandler, boolean verbose,
  SecretManager<? extends TokenIdentifier> secretManager,
  String portRangeConfig, AlignmentContext alignmentContext)
  throws IOException { super(protocolClass, protocolImpl, conf, bindAddress, port, numHandlers, numReaders, queueSizePerHandler, verbose, secretManager, portRangeConfig, alignmentContext); }

  The description of numReaders, queueSizePerHandler, and secretManager is missing here.

Issue Links

• links to: GitHub Pull Request #3256