The inverse of create_new_connections(). Will close and remove IB socket connections as directed.
disconnect( number_to_disconnect = "all", disconnect_master = FALSE, disconnect_tws = FALSE )
| number_to_disconnect | Integer. Total number of sockets to disconnect, including Master and TWS connections if included. |
|---|---|
| disconnect_master | Boolean, default FALSE. If TRUE, then the master_client_idMaster Client Socket will be disconnected if it exists. |
| disconnect_tws | Boolean, default FALSE. If TRUE, then the client_id_0TWS Socket will be disconnected if it exists. |
create_new_connections
Other utilities:
active_connection_parameters(),
clean_slate(),
create_new_connections(),
read_sock_drawer(),
socks(),
start_api(),
sync_timeout()
# Creating and Disconnecting IB Sockets # The following example walks you through creating and disconnecting the three # kinds of async socks: Master, TWS, and general. After each step, socks() is # called to view the current connected sockets so that you can observe what's # been created / disconnected. # As you go through this example yourself, remember that it's helpful to use the # "connections" window in the Interactive Brokers apps. In IB Gateway, you can # easily see connections from the default window; in TWS, it can be accessed by # clicking on the "DATA" text in the upper right-hand corner of the user # interface window of the app. # Disconnect all sockets that might exist so that we start with a clean slate. disconnect()#> ℹ Sock drawer currently contains 0 socks.# Create five (5) new socket connections. Include a Master and a TWS Socket. create_new_connections(5, include_master = TRUE, include_tws = TRUE) # Print the socket connections you created socks()#> master: A socket connection on '->localhost:7497'. #> Client ID: 22998 Server Version: 155 Connection time: 2020-03-17 13:11:59 #> Subscriptions: #> None #> sock_1: A socket connection on '->localhost:7497'. #> Client ID: 1 Server Version: 155 Connection time: 2020-03-17 13:11:59 #> Subscriptions: #> None #> sock_2: A socket connection on '->localhost:7497'. #> Client ID: 2 Server Version: 155 Connection time: 2020-03-17 13:11:59 #> Subscriptions: #> None #> sock_3: A socket connection on '->localhost:7497'. #> Client ID: 3 Server Version: 155 Connection time: 2020-03-17 13:12:00 #> Subscriptions: #> None #> tws: A socket connection on '->localhost:7497'. #> Client ID: 0 Server Version: 155 Connection time: 2020-03-17 13:11:59 #> Subscriptions: #> None #># Remove two general-purpose (i.e., not TWS or Master) sockets: disconnect(2)#> ✔ Disconnected 2 sockets.# See that two general-purpose connections are now gone socks()#> master: A socket connection on '->localhost:7497'. #> Client ID: 22998 Server Version: 155 Connection time: 2020-03-17 13:11:59 #> Subscriptions: #> None #> sock_1: A socket connection on '->localhost:7497'. #> Client ID: 1 Server Version: 155 Connection time: 2020-03-17 13:11:59 #> Subscriptions: #> None #> tws: A socket connection on '->localhost:7497'. #> Client ID: 0 Server Version: 155 Connection time: 2020-03-17 13:11:59 #> Subscriptions: #> None #>#> master: A socket connection on '->localhost:7497'. #> Client ID: 22998 Server Version: 155 Connection time: 2020-03-17 13:11:59 #> Subscriptions: #> None #> sock_1: A socket connection on '->localhost:7497'. #> Client ID: 1 Server Version: 155 Connection time: 2020-03-17 13:11:59 #> Subscriptions: #> None #> sock_2: A socket connection on '->localhost:7497'. #> Client ID: 2 Server Version: 155 Connection time: 2020-03-17 13:12:00 #> Subscriptions: #> None #> sock_3: A socket connection on '->localhost:7497'. #> Client ID: 3 Server Version: 155 Connection time: 2020-03-17 13:12:01 #> Subscriptions: #> None #> tws: A socket connection on '->localhost:7497'. #> Client ID: 0 Server Version: 155 Connection time: 2020-03-17 13:11:59 #> Subscriptions: #> None #># Disconnect only the TWS and the Master, view with socks() disconnect( number_to_disconnect = 2, disconnect_master = TRUE, disconnect_tws = TRUE )#> ✔ Master socket disconnected. #> ✔ TWS socket (Client ID = 0) disconnected.socks()#> sock_1: A socket connection on '->localhost:7497'. #> Client ID: 1 Server Version: 155 Connection time: 2020-03-17 13:11:59 #> Subscriptions: #> None #> sock_2: A socket connection on '->localhost:7497'. #> Client ID: 2 Server Version: 155 Connection time: 2020-03-17 13:12:00 #> Subscriptions: #> None #> sock_3: A socket connection on '->localhost:7497'. #> Client ID: 3 Server Version: 155 Connection time: 2020-03-17 13:12:01 #> Subscriptions: #> None #># Re-connect TWS and Master, view with socks() create_new_connections( number_of_new_socks = 2, include_master = TRUE, include_tws = TRUE ) socks()#> master: A socket connection on '->localhost:7497'. #> Client ID: 22998 Server Version: 155 Connection time: 2020-03-17 13:12:01 #> Subscriptions: #> None #> sock_1: A socket connection on '->localhost:7497'. #> Client ID: 1 Server Version: 155 Connection time: 2020-03-17 13:11:59 #> Subscriptions: #> None #> sock_2: A socket connection on '->localhost:7497'. #> Client ID: 2 Server Version: 155 Connection time: 2020-03-17 13:12:00 #> Subscriptions: #> None #> sock_3: A socket connection on '->localhost:7497'. #> Client ID: 3 Server Version: 155 Connection time: 2020-03-17 13:12:01 #> Subscriptions: #> None #> tws: A socket connection on '->localhost:7497'. #> Client ID: 0 Server Version: 155 Connection time: 2020-03-17 13:12:01 #> Subscriptions: #> None #># Disconnect ALL socks, view with socks() disconnect()#> Sock drawer cleaned out! #> ✔ Disconnected 1 sockets.socks()