util/IServerSocket.h

/**
 * Copyright (c) 2018-present, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree.
 */
#pragma once

#include <wdt/ErrorCodes.h>
#include <wdt/util/EncryptionUtils.h>

#include <netdb.h>
#include <string>

namespace facebook {
namespace wdt {

typedef struct addrinfo *addrInfoList;

class IServerSocket {
 public:
  virtual ~IServerSocket() {
  }
  /**
   * Begin listening for connections
   */
  virtual ErrorCode listen() = 0;
  /**
   * Accept the next (/only) incoming connection.
   */
  virtual ErrorCode acceptNextConnection(int timeoutMillis,
                                         bool tryCurAddressFirst) = 0;
  /// @return       peer ip
  virtual std::string getPeerIp() const = 0;
  /// @return       peer port
  virtual std::string getPeerPort() const = 0;
  virtual int getBackLog() const = 0;
  /**
   * Stops accepting new connections, closes the server socket, and terminates
   * the active connection. This should be avoided. Use closeConnection()
   * instead
   */
  virtual void closeAllNoCheck() = 0;
  /**
   * Tries to read nbyte data and periodically checks for abort
   */
  virtual int read(char *buf, int nbyte, bool tryFull = true) = 0;
  /**
  * Tries to read nbyte data with a specific timeout and periodically checks
  * for abort
  */
  virtual int readWithTimeout(char *buf, int nbyte, int timeoutMs,
                              bool tryFull) = 0;
  /**
  * tries to write nbyte data, if retry is true, socket tries
  * to write as long as it makes some progress within a write timeout
  */
  virtual int write(char *buf, int nbyte, bool retry = false) = 0;

  virtual ErrorCode shutdownWrites() = 0;

  virtual ErrorCode expectEndOfStream() = 0;
  /**
   * Normal closing of the current connection.
   */
  virtual ErrorCode closeConnection() = 0;
  /**
   * Close unexpectedly.
   * This api is to be avoided/elminated.
   */
  virtual void closeNoCheck() = 0;
  /// @return     current fd
  virtual int getFd() const = 0;
  /// @return     port
  virtual int getPort() const = 0;
  /// @return     current encryption type
  virtual EncryptionType getEncryptionType() const = 0;
  /// @return     possible non-retryable error
  virtual ErrorCode getNonRetryableErrCode() const = 0;
  /// @return     read error code
  virtual ErrorCode getReadErrCode() const = 0;
  /// @return     write error code
  virtual ErrorCode getWriteErrCode() const = 0;

  virtual void disableIvChange() = 0;
};
}  // namespace wdt
}  // namespace facebook