session

Documentation

Overview

Package session provides session management utility and token storage.

Index

• type Session
  • func NewSession(configs ...phpipam.Config) *Session
  • func (s *Session) SetHttpClient(hc *http.Client)
• type Token

Types

type Session

type Session struct {
	// The session's configuration.
	Config phpipam.Config

	// The session token.
	Token Token

	// A session shares this client if provided
	HttpClient *http.Client

	sync.RWMutex // protect updates of HttpClient

}

Session represents a PHPIPAM session.

func NewSession

func NewSession(configs ...phpipam.Config) *Session

NewSession creates a new session based off supplied configs. It is up to the client for each controller implementation to log in and refresh the token. This is provided in the base client.Client implementation.

func (*Session) SetHttpClient

func (s *Session) SetHttpClient(hc *http.Client)

SetHttpClient sets a specific http client with a particular transport etc For backwards compatibility, a CheckRedirect function will be added at call time if not present

type Token

type Token struct {
	// The token string.
	String string `json:"token"`
}

Token represents a PHPIPAM session token.