session

Documentation

Index

• Constants
• type IRODSSession
  • func NewIRODSSession(account *types.IRODSAccount, config *IRODSSessionConfig) (*IRODSSession, error)
  • func (sess *IRODSSession) AcquireConnection() (*connection.IRODSConnection, error)
  • func (sess *IRODSSession) Connections() int
  • func (sess *IRODSSession) Release()
  • func (sess *IRODSSession) ReturnConnection(conn *connection.IRODSConnection) error
• type IRODSSessionConfig
  • func NewIRODSSessionConfig(applicationName string, operationTimeout time.Duration, ...) *IRODSSessionConfig
  • func NewIRODSSessionConfigWithDefault(applicationName string) *IRODSSessionConfig

Constants

const (
	// IRODSSessionConnectionMaxMin is a minimum value for connection max
	IRODSSessionConnectionMaxMin = 5
	// IRODSSessionConnectionMaxDefault is a default value for connection max
	IRODSSessionConnectionMaxDefault = 10
	// IRODSSessionTimeoutDefault is a default value for timeout
	IRODSSessionTimeoutDefault = 5 * time.Minute
)

Types

type IRODSSession

type IRODSSession struct {
	Account        *types.IRODSAccount
	Config         *IRODSSessionConfig
	ConnectionPool pool.Pool
}

IRODSSession manages connections to iRODS

func NewIRODSSession

func NewIRODSSession(account *types.IRODSAccount, config *IRODSSessionConfig) (*IRODSSession, error)

NewIRODSSession create a IRODSSession

func (*IRODSSession) AcquireConnection

func (sess *IRODSSession) AcquireConnection() (*connection.IRODSConnection, error)

AcquireConnection returns an idle connection

func (*IRODSSession) Connections

func (sess *IRODSSession) Connections() int

Connections returns the number of connections in the pool

func (*IRODSSession) Release

func (sess *IRODSSession) Release()

Release releases all connections

func (*IRODSSession) ReturnConnection

func (sess *IRODSSession) ReturnConnection(conn *connection.IRODSConnection) error

ReturnConnection returns an idle connection

type IRODSSessionConfig

type IRODSSessionConfig struct {
	ApplicationName      string
	OperationTimeout     time.Duration
	IdleTimeout          time.Duration
	ConnectionMax        int
	ConnectionInitNumber int
	ConnectionMaxIdle    int
	StartNewTransaction  bool
}

IRODSSessionConfig is for session configuration

func NewIRODSSessionConfig

func NewIRODSSessionConfig(applicationName string, operationTimeout time.Duration, idleTimeout time.Duration, connectionMax int, startNewTransaction bool) *IRODSSessionConfig

NewIRODSSessionConfig create a IRODSSessionConfig

func NewIRODSSessionConfigWithDefault

func NewIRODSSessionConfigWithDefault(applicationName string) *IRODSSessionConfig

NewIRODSSessionConfigWithDefault create a IRODSSessionConfig with a default settings