tunnels

Documentation

Index

• type Client
  • func NewClient(cfg *ngrok.ClientConfig) *Client
  • func (c *Client) Get(ctx context.Context, id string) (*ngrok.Tunnel, error)
  • func (c *Client) List(paging *ngrok.Paging) *Iter
• type Iter
  • func (it *Iter) Err() error
  • func (it *Iter) Item() *ngrok.Tunnel
  • 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.Tunnel, error)

Get the status of a tunnel by ID

https://ngrok.com/docs/api#api-tunnels-get

func (*Client) List

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

List all online tunnels currently running on the account.

https://ngrok.com/docs/api#api-tunnels-list

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.Tunnel

Item() returns the Tunnel 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.