blpapi.Socks5Config

class blpapi.Socks5Config(hostname, port)

Configuration to be used to specify a SOCKS5 proxy

__init__(hostname, port)
Parameters:

  • hostname (str) – hostname of the SOCKS5 proxy

  • port (int) – port of the SOCKS5 proxy. Must be between 1 and 65535

Creates an object that defines a SOCKS5 proxy.

destroy()

Destroy the handle using stored dtor

Return type:

None

isValid()

Returns: True if this class holds a handle and the handle is not None.

Return type:

bool

toString(level=0, spacesPerLevel=4)

Formats this Socks5Config to the string.

Parameters:

  • level (int) – Indentation level

  • spacesPerLevel (int) – Number of spaces per indentation level for this and all nested objects

Return type:

str

Returns:

This object formatted as a string

If level is negative, suppresses indentation of the first line. If spacesPerLevel is negative, formats the entire output on one line, suppressing all but the initial indentation (as governed by level).