tunnel_sessions

Documentation

Index

• type Client
  • func NewClient(cfg *ngrok.ClientConfig) *Client
  • func (c *Client) Get(ctx context.Context, id string) (*ngrok.TunnelSession, error)
  • func (c *Client) List(paging *ngrok.Paging) *Iter
  • func (c *Client) Restart(ctx context.Context, id string) error
  • func (c *Client) Stop(ctx context.Context, id string) error
  • func (c *Client) Update(ctx context.Context, id string) error
• type Iter
  • func (it *Iter) Err() error
  • func (it *Iter) Item() *ngrok.TunnelSession
  • func (it *Iter) Next(ctx context.Context) bool

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(cfg *ngrok.ClientConfig) *Client

func (*Client) Get

func (c *Client) Get(ctx context.Context, id string) (*ngrok.TunnelSession, error)

Get the detailed status of a tunnel session by ID

https://ngrok.com/docs/api#api-tunnel-sessions-get

func (*Client) List

func (c *Client) List(paging *ngrok.Paging) *Iter

List all online tunnel sessions running on this account.

https://ngrok.com/docs/api#api-tunnel-sessions-list

func (*Client) Restart

func (c *Client) Restart(ctx context.Context, id string) error

Issues a command instructing the ngrok agent to restart. The agent restarts itself by calling exec() on platforms that support it. This operation is notably not supported on Windows. When an agent restarts, it reconnects with a new tunnel session ID.

https://ngrok.com/docs/api#api-tunnel-sessions-restart

func (*Client) Stop

func (c *Client) Stop(ctx context.Context, id string) error

Issues a command instructing the ngrok agent that started this tunnel session to exit.

https://ngrok.com/docs/api#api-tunnel-sessions-stop

func (*Client) Update

func (c *Client) Update(ctx context.Context, id string) error

Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent's configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted

https://ngrok.com/docs/api#api-tunnel-sessions-update

type Iter

type Iter struct {
	// contains filtered or unexported fields
}

Iter allows the caller to iterate through a list of values while automatically fetching new pages worth of values from the API.

func (*Iter) Err

func (it *Iter) Err() error

If Next() returned false because an error was encountered while fetching the next value Err() will return that error. A caller should always check Err() after Next() returns false.

func (*Iter) Item

func (it *Iter) Item() *ngrok.TunnelSession

Item() returns the TunnelSession currently pointed to by the iterator.

func (*Iter) Next

func (it *Iter) Next(ctx context.Context) bool

Next returns true if there is another value available in the iterator. If it returs true it also advances the iterator to that next available item.