connection

package
v0.7.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 16, 2022 License: BSD-3-Clause Imports: 18 Imported by: 6

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ErrInvalidUTF8 = errors.New("invalid utf-8 character")

ErrInvalidUTF8 is returned if an invalid utf-8 character is found.

Functions

This section is empty.

Types

type CheckErrorResponse added in v0.4.4 

type CheckErrorResponse interface {
	Response
	CheckError() error
}

A CheckErrorResponse is a Response on which CheckError can be called.

type IRODSConnection 

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

IRODSConnection connects to iRODS

func NewIRODSConnection 

func NewIRODSConnection(account *types.IRODSAccount, requestTimeout time.Duration, applicationName string) *IRODSConnection

NewIRODSConnection create a IRODSConnection

func (*IRODSConnection) ClearTransferMetrics added in v0.5.11 

func (conn *IRODSConnection) ClearTransferMetrics()

ClearTransferMetrics clears transfer metrics

func (*IRODSConnection) Commit added in v0.4.4 

func (conn *IRODSConnection) Commit() error

Commit a transaction. This is useful in combination with the NO_COMMIT_FLAG. Usage is limited to privileged accounts.

func (*IRODSConnection) Connect 

func (conn *IRODSConnection) Connect() error

Connect connects to iRODS

func (*IRODSConnection) Disconnect 

func (conn *IRODSConnection) Disconnect() error

Disconnect disconnects

func (*IRODSConnection) GetAccount added in v0.6.0 

func (conn *IRODSConnection) GetAccount() *types.IRODSAccount

GetAccount returns iRODSAccount

func (*IRODSConnection) GetCreationTime added in v0.6.0 

func (conn *IRODSConnection) GetCreationTime() time.Time

GetCreationTime returns creation time

func (*IRODSConnection) GetGeneratedPasswordForPAMAuth added in v0.4.4 

func (conn *IRODSConnection) GetGeneratedPasswordForPAMAuth() string

GetGeneratedPasswordForPAMAuth returns generated Password For PAM Auth

func (*IRODSConnection) GetLastSuccessfulAccess added in v0.5.6 

func (conn *IRODSConnection) GetLastSuccessfulAccess() time.Time

GetLastSuccessfulAccess returns last successful access time

func (*IRODSConnection) GetTransferMetrics added in v0.5.11 

func (conn *IRODSConnection) GetTransferMetrics() types.TransferMetrics

GetTransferMetrics returns transfer metrics

func (*IRODSConnection) GetVersion 

func (conn *IRODSConnection) GetVersion() *types.IRODSVersion

GetVersion returns iRODS version

func (*IRODSConnection) IncreaseCollectionMetricsCreate added in v0.5.11 

func (conn *IRODSConnection) IncreaseCollectionMetricsCreate(n uint64)

IncreaseCollectionMetricsCreate increases create collection metrics

func (*IRODSConnection) IncreaseCollectionMetricsDelete added in v0.5.11 

func (conn *IRODSConnection) IncreaseCollectionMetricsDelete(n uint64)

IncreaseCollectionMetricsDelete increases delete collection metrics

func (*IRODSConnection) IncreaseCollectionMetricsList added in v0.5.11 

func (conn *IRODSConnection) IncreaseCollectionMetricsList(n uint64)

IncreaseCollectionMetricsList increases list collection metrics

func (*IRODSConnection) IncreaseCollectionMetricsMeta added in v0.5.11 

func (conn *IRODSConnection) IncreaseCollectionMetricsMeta(n uint64)

IncreaseCollectionMetricsMeta increases meta collection metrics

func (*IRODSConnection) IncreaseCollectionMetricsRename added in v0.5.11 

func (conn *IRODSConnection) IncreaseCollectionMetricsRename(n uint64)

IncreaseCollectionMetricsRename increases rename collection metrics

func (*IRODSConnection) IncreaseCollectionMetricsStat added in v0.5.11 

func (conn *IRODSConnection) IncreaseCollectionMetricsStat(n uint64)

IncreaseCollectionMetricsStat increases stat collection metrics

func (*IRODSConnection) IncreaseDataObjectMetricsCreate added in v0.5.11 

func (conn *IRODSConnection) IncreaseDataObjectMetricsCreate(n uint64)

IncreaseDataObjectMetricsCreate increases create data object metrics

func (*IRODSConnection) IncreaseDataObjectMetricsDelete added in v0.5.11 

func (conn *IRODSConnection) IncreaseDataObjectMetricsDelete(n uint64)

IncreaseDataObjectMetricsDelete increases delete data object metrics

func (*IRODSConnection) IncreaseDataObjectMetricsMeta added in v0.5.11 

func (conn *IRODSConnection) IncreaseDataObjectMetricsMeta(n uint64)

IncreaseDataObjectMetricsMeta increases meta data object metrics

func (*IRODSConnection) IncreaseDataObjectMetricsRead added in v0.5.11 

func (conn *IRODSConnection) IncreaseDataObjectMetricsRead(n uint64)

IncreaseDataObjectMetricsRead increases read data object metrics

func (*IRODSConnection) IncreaseDataObjectMetricsRename added in v0.5.11 

func (conn *IRODSConnection) IncreaseDataObjectMetricsRename(n uint64)

IncreaseDataObjectMetricsRename increases rename data object metrics

func (*IRODSConnection) IncreaseDataObjectMetricsStat added in v0.5.11 

func (conn *IRODSConnection) IncreaseDataObjectMetricsStat(n uint64)

IncreaseDataObjectMetricsStat increases stat data object metrics

func (*IRODSConnection) IncreaseDataObjectMetricsWrite added in v0.5.11 

func (conn *IRODSConnection) IncreaseDataObjectMetricsWrite(n uint64)

IncreaseDataObjectMetricsWrite increases write data object metrics

func (*IRODSConnection) IncreaseTransferMetricsBytesReceived added in v0.5.11 

func (conn *IRODSConnection) IncreaseTransferMetricsBytesReceived(n uint64)

IncreaseTransferMetricsBytesReceived increases bytes received metrics

func (*IRODSConnection) IncreaseTransferMetricsBytesSent added in v0.5.11 

func (conn *IRODSConnection) IncreaseTransferMetricsBytesSent(n uint64)

IncreaseTransferMetricsBytesSent increases bytes sent metrics

func (*IRODSConnection) IsConnected 

func (conn *IRODSConnection) IsConnected() bool

IsConnected returns if the connection is live

func (*IRODSConnection) PoorMansRollback added in v0.4.4 

func (conn *IRODSConnection) PoorMansRollback() error

PoorMansRollback rolls back a transaction as a nonprivileged account, bypassing API limitations. A nonprivileged account cannot have staged operations, so rollback is always a no-op. The usage for this function, is that rolling back the current database transaction still will start a new one, so that future queries will see all changes that where made up to calling this function.

func (*IRODSConnection) PostprocessMessage added in v0.4.4 

func (conn *IRODSConnection) PostprocessMessage(msg *message.IRODSMessage) error

PostprocessMessage prepares a message that is received from irods for XML parsing.

func (*IRODSConnection) PostprocessXML added in v0.4.4 

func (conn *IRODSConnection) PostprocessXML(in []byte) (out []byte, err error)

PostprocessXML translates IRODS XML into valid XML. We fix the invalid encoding of ` as &quot.

func (*IRODSConnection) PreprocessMessage added in v0.4.4 

func (conn *IRODSConnection) PreprocessMessage(msg *message.IRODSMessage) error

PreprocessMessage modifies a request message to use irods dialect for XML.

func (*IRODSConnection) PreprocessXML added in v0.4.4 

func (conn *IRODSConnection) PreprocessXML(in []byte) (out []byte, err error)

PreprocessXML translates output of xml.Marshal into XML that IRODS understands.

func (*IRODSConnection) RawBind added in v0.4.5 

func (conn *IRODSConnection) RawBind(socket net.Conn)

RawBind binds an IRODSConnection to a raw net.Conn socket - to be used for e.g. a proxy server setup

func (*IRODSConnection) ReadMessage 

func (conn *IRODSConnection) ReadMessage() (*message.IRODSMessage, error)

ReadMessage reads data from the given socket and returns IRODSMessage

func (*IRODSConnection) ReadMessageHeader added in v0.6.0 

func (conn *IRODSConnection) ReadMessageHeader() (*message.IRODSMessageHeader, error)

readMessageHeader reads data from the given connection and returns iRODSMessageHeader

func (*IRODSConnection) Recv 

func (conn *IRODSConnection) Recv(buffer []byte, size int) (int, error)

Recv receives a message

func (*IRODSConnection) Request added in v0.4.4 

func (conn *IRODSConnection) Request(request Request, response Response) error

Request sends a request and expects a response.

func (*IRODSConnection) RequestAndCheck added in v0.4.4 

func (conn *IRODSConnection) RequestAndCheck(request Request, response CheckErrorResponse) error

RequestAndCheck sends a request and expects a CheckErrorResponse, on which the error is already checked.

func (*IRODSConnection) Rollback added in v0.4.4 

func (conn *IRODSConnection) Rollback() error

Rollback a transaction. This is useful in combination with the NO_COMMIT_FLAG. It can also be used to clear the current database transaction if there are no staged operations, just to refresh the view on the database for future queries. Usage is limited to privileged accounts.

func (*IRODSConnection) Send 

func (conn *IRODSConnection) Send(buffer []byte, size int) error

Send sends data

func (*IRODSConnection) SendMessage 

func (conn *IRODSConnection) SendMessage(msg *message.IRODSMessage) error

SendMessage makes the message into bytes

type Request added in v0.4.4 

type Request interface {
	GetMessage() (*message.IRODSMessage, error)
}

A Request to send to irods.

type Response added in v0.4.4 

type Response interface {
	FromMessage(*message.IRODSMessage) error
}

A Response to retrieve from irods.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.