R/active_connection_parameters.R

In JakeVestal/InteractiveTradeR: API

#' Retreive Active Connection Parameters
#'
#' Return a \link[tibble]{tibble} that prints nicely and contains the connection
#' info that InteractiveTradeR is currently using to to interface with the
#' Interactive Brokers TWS / IBG application.
#'
#' @example inst/examples/active_connection_parameters_ex.R
#' @family utilities
#' @export
#' 
active_connection_parameters <- function(){
  structure(
    tibble::tibble(
      live             = !unlist(
        options("interactivetrader.paper"),
        use.names = FALSE
      ),
      platform         = unlist(
        options("interactivetrader.platform"),
        use.names = FALSE
      ),
      port             = active_itr_option("port"),
      host             = active_itr_option("host"),
      master_client_id = active_itr_option("master")
    )
    ,
    class = c("active_conn_params", "tbl_df", "tbl", "data.frame")
  )
}