HandlerSocket Configuration Options

You are viewing an old version of this article. View the current version here.

The HandlerSocket plugin has the following options.

Add the options to the [mysqld] section of your my.cnf file.


handlersocket_verbose

  • Description: Specify the logging verbosity.
  • Commandline: --handlersocket_verbose="value"
  • Scope: Global
  • Dynamic: No
  • Type: number
  • Valid values:
    • Min: 0
    • Max: 10000
  • Default Value: 10

handlersocket_address

  • Description: Specify the IP address to bind to.
  • Commandline: --handlersocket_address="value"
  • Scope: Global
  • Dynamic: No
  • Type: IP Address
  • Default Value: 0.0.0.0

handlersocket_port

  • Description: Specify the port to bind to for reads. An empty value disables the listener.
  • Commandline: --handlersocket_port="value"
  • Scope: Global
  • Dynamic: No
  • Type: number
  • Default Value: 9998

handlersocket_port_wr

  • Description: Specify the port to bind to for writes. An empty value disables the listener.
  • Commandline: --handlersocket_port_wr="value"
  • Scope: Global
  • Dynamic: No
  • Type: number
  • Default Value: 9999

handlersocket_epoll

  • Description: Specify whether to use epoll for I/O multiplexing.
  • Commandline: --handlersocket_epoll="value"
  • Scope: Global
  • Dynamic: No
  • Type: number
  • Valid values:
    • Min: 0
    • Max: 1
  • Default Value: 1

handlersocket_threads

  • Description: Specify the number of worker threads for reads. Recommended value = ((# CPU cores) * 2).
  • Commandline: --handlersocket_threads="value"
  • Scope: Global
  • Dynamic: No
  • Type: number
  • Valid values:
    • Min: 1
    • Max: 3000
  • Default Value: 16

handlersocket_threads_wr

  • Description: Specify the number of worker threads for writes. Recommended value = 1.
  • Commandline: --handlersocket_threads_wr="value"
  • Scope: Global
  • Dynamic: No
  • Type: number
  • Valid values:
    • Min: 1
    • Max: 3000
  • Default Value: 1

handlersocket_timeout

  • Description: Specify the socket timeout in seconds.
  • Commandline: --handlersocket_timeout="value"
  • Scope: Global
  • Dynamic: No
  • Type: number
  • Valid values:
    • Min: 30
    • Max: 3600
  • Default Value: 300

handlersocket_backlog

  • Description: Specify the listen backlog length.
  • Commandline: --handlersocket_backlog="value"
  • Scope: Global
  • Dynamic: No
  • Type: number
  • Valid values:
    • Min: 5
    • Max: 1000000
  • Default Value: 32768

handlersocket_sndbuf

  • Description: Specify the maximum socket send buffer (in bytes). If '0' then the system default is used.
  • Commandline: --handlersocket_sndbuf="value"
  • Scope: Global
  • Dynamic: No
  • Type: number
  • Valid values:
    • Min: 0
    • Max: 1677216
  • Default Value: 0

handlersocket_rcvbuf

  • Description: Specify the maximum socket receive buffer (in bytes). If '0' then the system default is used.
  • Commandline: --handlersocket_rcvbuf="value"
  • Scope: Global
  • Dynamic: No
  • Type: number
  • Valid values:
    • Min: 0
    • Max: 1677216
  • Default Value: 0

handlersocket_readsize

  • Description: Specify the minimum length of the request buffer. Larger values consume available memory but can make handlersocket faster for large requests.
  • Commandline: --handlersocket_readsize="value"
  • Scope: Global
  • Dynamic: No
  • Type: number
  • Valid values:
    • Min: 0
    • Max: 1677216
  • Default Value: 0 (possibly 4096)

handlersocket_accept_balance

  • Description: When set to a value other than zero ('0'), handlersocket will try to balance accepted connections among threads. Default is 0 but if you use persistent connections (for example if you use client-side connection pooling) then a non-zero value is recommended.
  • Commandline: --handlersocket_accept_balance="value"
  • Scope: Global
  • Dynamic: No
  • Type: number
  • Valid values:
    • Min: 0
    • Max: 10000
  • Default Value: 0

handlersocket_wrlock_timeout

  • Description: The write lock timeout in seconds. When acting on write requests, handlersocket locks an advisory lock named 'handlersocket_wr' and this option sets the timeout for it.
  • Commandline: --handlersocket_wrlock_timeout="value"
  • Scope: Global
  • Dynamic: No
  • Type: number
  • Valid values:
    • Min: 0
    • Max: 3600
  • Default Value: 12

Comments

Comments loading...
Content reproduced on this site is the property of its respective owners, and this content is not reviewed in advance by MariaDB. The views, information and opinions expressed by this content do not necessarily represent those of MariaDB or any other party.