tcp

Documentation

Index

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

func (c *Client) Create(ctx context.Context, arg *ngrok.TCPEdgeCreate) (*ngrok.TCPEdge, error)

Create a TCP Edge

https://ngrok.com/docs/api#api-edges-tcp-create

func (*Client) Delete

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

Delete a TCP Edge by ID

https://ngrok.com/docs/api#api-edges-tcp-delete

func (*Client) Get

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

Get a TCP Edge by ID

https://ngrok.com/docs/api#api-edges-tcp-get

func (*Client) List

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

Returns a list of all TCP Edges on this account

https://ngrok.com/docs/api#api-edges-tcp-list

func (*Client) Update

func (c *Client) Update(ctx context.Context, arg *ngrok.TCPEdgeUpdate) (*ngrok.TCPEdge, error)

Updates a TCP Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.

https://ngrok.com/docs/api#api-edges-tcp-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.TCPEdge

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