message

package
v0.14.5 Latest Latest
Warning

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

 Go to latest Published: Apr 30, 2024 License: BSD-3-Clause Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	RODS_MESSAGE_CS_NEG_TYPE MessageType = "RODS_CS_NEG_T"

	// Keywords
	CS_NEG_SID_KW string = "cs_neg_sid_kw" // unknown

)

negotiation constants

View Source 
const (
	// RODS_MESSAGE_CONNECT_TYPE is a message type for establishing a new connection
	RODS_MESSAGE_CONNECT_TYPE MessageType = "RODS_CONNECT"
	// RequestNegotiationOptionString is an option string for requesting server negotiation
	RequestNegotiationOptionString string = "request_server_negotiation"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ErrorMsg added in v0.6.0 

type ErrorMsg struct {
	XMLName xml.Name `xml:"RErrMsg_PI"`
	Status  int      `xml:"status"`
	Message string   `xml:"msg"`
}

type IRODSMessage 

type IRODSMessage struct {
	Header *IRODSMessageHeader
	Body   *IRODSMessageBody
}

IRODSMessage defines a message

type IRODSMessageAdminRequest added in v0.4.4 

type IRODSMessageAdminRequest struct {
	XMLName xml.Name `xml:"generalAdminInp_PI"`
	Action  string   `xml:"arg0"` // add, modify, rm, ...
	Target  string   `xml:"arg1"` // user, group, zone, resource, ...
	Arg2    string   `xml:"arg2"`
	Arg3    string   `xml:"arg3"`
	Arg4    string   `xml:"arg4"`
	Arg5    string   `xml:"arg5"`
	Arg6    string   `xml:"arg6"`
	Arg7    string   `xml:"arg7"`
	Arg8    string   `xml:"arg8"` // unused
	Arg9    string   `xml:"arg9"` // unused
}

IRODSMessageAdminRequest stores alter metadata request

func NewIRODSMessageAdminRequest added in v0.4.4 

func NewIRODSMessageAdminRequest(action, target string, args ...string) *IRODSMessageAdminRequest

NewIRODSMessageAdminRequest creates a new IRODSMessageAdminRequest

func (*IRODSMessageAdminRequest) FromBytes added in v0.4.4 

func (msg *IRODSMessageAdminRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageAdminRequest) GetBytes added in v0.4.4 

func (msg *IRODSMessageAdminRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageAdminRequest) GetMessage added in v0.4.4 

func (msg *IRODSMessageAdminRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageAdminResponse added in v0.4.4 

type IRODSMessageAdminResponse struct {
	// empty structure
	Result int
}

IRODSMessageAdminResponse stores alter metadata response

func (*IRODSMessageAdminResponse) CheckError added in v0.4.4 

func (msg *IRODSMessageAdminResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageAdminResponse) FromMessage added in v0.4.4 

func (msg *IRODSMessageAdminResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageAuthChallengeResponse added in v0.10.2 

type IRODSMessageAuthChallengeResponse struct {
	XMLName   xml.Name `xml:"authRequestOut_PI"`
	Challenge string   `xml:"challenge"`
}

IRODSMessageAuthChallengeResponse stores auth challenge

func (*IRODSMessageAuthChallengeResponse) FromBytes added in v0.10.2 

func (msg *IRODSMessageAuthChallengeResponse) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageAuthChallengeResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageAuthChallengeResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessageAuthChallengeResponse) GetBytes added in v0.10.2 

func (msg *IRODSMessageAuthChallengeResponse) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageAuthChallengeResponse) GetChallenge added in v0.10.2 

func (msg *IRODSMessageAuthChallengeResponse) GetChallenge() ([]byte, error)

GetChallenge returns challenge bytes

func (*IRODSMessageAuthChallengeResponse) GetMessage added in v0.10.2 

func (msg *IRODSMessageAuthChallengeResponse) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageAuthPluginRequest added in v0.10.2 

type IRODSMessageAuthPluginRequest struct {
	XMLName    xml.Name `xml:"authPlugReqInp_PI"`
	AuthScheme string   `xml:"auth_scheme_"`
	Context    string   `xml:"context_"`
}

IRODSMessageAuthPluginRequest stores auth plugin request

func NewIRODSMessageAuthPluginRequest added in v0.10.2 

func NewIRODSMessageAuthPluginRequest(authScheme string, context string) *IRODSMessageAuthPluginRequest

NewIRODSMessageAuthPluginRequest creates a IRODSMessageAuthPluginRequest

func (*IRODSMessageAuthPluginRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageAuthPluginRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageAuthPluginRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageAuthPluginRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageAuthPluginRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageAuthPluginRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageAuthPluginResponse added in v0.10.2 

type IRODSMessageAuthPluginResponse struct {
	XMLName xml.Name `xml:"authPlugReqOut_PI"`
	Result  string   `xml:"result_"`
}

IRODSMessageAuthPluginResponse stores auth plugin info

func NewIRODSMessageAuthPluginResponse added in v0.10.2 

func NewIRODSMessageAuthPluginResponse(result string) *IRODSMessageAuthPluginResponse

NewIRODSMessageAuthPluginResponse creates a IRODSMessageAuthPluginResponse

func (*IRODSMessageAuthPluginResponse) FromBytes added in v0.10.2 

func (msg *IRODSMessageAuthPluginResponse) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageAuthPluginResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageAuthPluginResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessageAuthPluginResponse) GetBytes added in v0.10.2 

func (msg *IRODSMessageAuthPluginResponse) GetBytes() ([]byte, error)

GetBytes returns byte array

type IRODSMessageAuthRequest 

type IRODSMessageAuthRequest struct {
}

IRODSMessageAuthRequest stores authentication request

func NewIRODSMessageAuthRequest 

func NewIRODSMessageAuthRequest() *IRODSMessageAuthRequest

NewIRODSMessageAuthRequest creates a IRODSMessageAuthRequest message

func (*IRODSMessageAuthRequest) FromMessage added in v0.6.0 

func (msg *IRODSMessageAuthRequest) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessageAuthRequest) GetMessage 

func (msg *IRODSMessageAuthRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageAuthResponse 

type IRODSMessageAuthResponse struct {
	XMLName  xml.Name `xml:"authResponseInp_PI"`
	Response string   `xml:"response"`
	Username string   `xml:"username"`
}

IRODSMessageAuthResponse stores auth response

func NewIRODSMessageAuthResponse 

func NewIRODSMessageAuthResponse(response string, username string) *IRODSMessageAuthResponse

NewIRODSMessageAuthResponse creates a IRODSMessageAuthResponse message

func (*IRODSMessageAuthResponse) FromBytes 

func (msg *IRODSMessageAuthResponse) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageAuthResponse) FromMessage added in v0.6.0 

func (msg *IRODSMessageAuthResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessageAuthResponse) GetBytes 

func (msg *IRODSMessageAuthResponse) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageAuthResponse) GetMessage 

func (msg *IRODSMessageAuthResponse) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageAuthResult 

type IRODSMessageAuthResult struct {
	// empty structure
	Result int
}

IRODSMessageAuthResult stores authentication result

func (*IRODSMessageAuthResult) CheckError 

func (msg *IRODSMessageAuthResult) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageAuthResult) FromMessage 

func (msg *IRODSMessageAuthResult) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessageAuthResult) GetMessage added in v0.6.0 

func (msg *IRODSMessageAuthResult) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageBinBytesBuf added in v0.5.8 

type IRODSMessageBinBytesBuf struct {
	XMLName xml.Name `xml:"BinBytesBuf_PI"`

	Length int    `xml:"buflen"`
	Data   string `xml:"buf"` // data is base64 encoded

	Result int
}

IRODSMessageBinBytesBuf stores bytes buffer

type IRODSMessageBody 

type IRODSMessageBody struct {
	Type    MessageType
	Message []byte
	Error   []byte
	Bs      []byte
	IntInfo int32
}

IRODSMessageBody defines a message body

func (*IRODSMessageBody) BuildHeader 

func (body *IRODSMessageBody) BuildHeader() (*IRODSMessageHeader, error)

BuildHeader returns IRODSMessageHeader

func (*IRODSMessageBody) FromBytes 

func (body *IRODSMessageBody) FromBytes(header *IRODSMessageHeader, bodyBytes []byte, bsBytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageBody) GetBytes 

func (body *IRODSMessageBody) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageBody) GetBytesWithoutBS added in v0.9.0 

func (body *IRODSMessageBody) GetBytesWithoutBS() ([]byte, error)

GetBytesWithoutBS returns byte array of body without BS

type IRODSMessageByteData added in v0.10.2 

type IRODSMessageByteData struct {
	Type MessageType
	Data []byte
}

IRODSMessageByteData stores byte data

func NewIRODSMessageByteData added in v0.10.2 

func NewIRODSMessageByteData(msgType MessageType, data []byte) *IRODSMessageByteData

NewIRODSMessageByteData creates a IRODSMessageByteData message

func (*IRODSMessageByteData) GetMessageBody added in v0.10.2 

func (msg *IRODSMessageByteData) GetMessageBody() (*IRODSMessageBody, error)

GetMessageBody builds a message body

type IRODSMessageCSNegotiation 

type IRODSMessageCSNegotiation struct {
	XMLName xml.Name `xml:"CS_NEG_PI"`
	Status  int      `xml:"status"`
	Result  string   `xml:"result"`
}

IRODSMessageCSNegotiation stores client-server negotiation message

func NewIRODSMessageCSNegotiation 

func NewIRODSMessageCSNegotiation(result types.CSNegotiationPolicy) *IRODSMessageCSNegotiation

NewIRODSMessageCSNegotiation creates a IRODSMessageCSNegotiation message

func (*IRODSMessageCSNegotiation) CheckError 

func (msg *IRODSMessageCSNegotiation) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageCSNegotiation) FromBytes 

func (msg *IRODSMessageCSNegotiation) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageCSNegotiation) FromMessage 

func (msg *IRODSMessageCSNegotiation) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessageCSNegotiation) GetBytes 

func (msg *IRODSMessageCSNegotiation) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageCSNegotiation) GetMessage 

func (msg *IRODSMessageCSNegotiation) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageChecksumRequest added in v0.12.6 

type IRODSMessageChecksumRequest IRODSMessageDataObjectRequest

IRODSMessageChecksumRequest stores data object checksum request

func NewIRODSMessageChecksumRequest added in v0.12.6 

func NewIRODSMessageChecksumRequest(path string, resource string) *IRODSMessageChecksumRequest

NewIRODSMessageChecksumRequest creates a IRODSMessageChecksumRequest message

func (*IRODSMessageChecksumRequest) AddKeyVal added in v0.12.6 

func (msg *IRODSMessageChecksumRequest) AddKeyVal(key common.KeyWord, val string)

AddKeyVal adds a key-value pair

func (*IRODSMessageChecksumRequest) FromBytes added in v0.12.6 

func (msg *IRODSMessageChecksumRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageChecksumRequest) GetBytes added in v0.12.6 

func (msg *IRODSMessageChecksumRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageChecksumRequest) GetMessage added in v0.12.6 

func (msg *IRODSMessageChecksumRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageChecksumResponse added in v0.12.6 

type IRODSMessageChecksumResponse struct {
	Checksum string `xml:"myStr"`
	// stores error return
	Result int `xml:"-"`
}

IRODSMessageChecksumResponse stores data object checksum response

func (*IRODSMessageChecksumResponse) CheckError added in v0.12.6 

func (msg *IRODSMessageChecksumResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageChecksumResponse) FromBytes added in v0.12.6 

func (msg *IRODSMessageChecksumResponse) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageChecksumResponse) FromMessage added in v0.12.6 

func (msg *IRODSMessageChecksumResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessageChecksumResponse) GetBytes added in v0.12.6 

func (msg *IRODSMessageChecksumResponse) GetBytes() ([]byte, error)

GetBytes returns byte array

type IRODSMessageCloseDataObjectReplicaRequest added in v0.10.2 

type IRODSMessageCloseDataObjectReplicaRequest struct {
	FileDescriptor            int  `json:"fd"`
	SendNotification          bool `json:"send_notification"`
	UpdateSize                bool `json:"update_size"`
	UpdateStatus              bool `json:"update_status"`
	ComputeChecksum           bool `json:"compute_checksum"`
	PreserveReplicaStateTable bool `json:"preserve_replica_state_table"`
}

IRODSMessageCloseDataObjectReplicaRequest stores data object replica close request Uses JSON, not XML Supported v4.2.9 or above

func NewIRODSMessageCloseDataObjectReplicaRequest added in v0.10.2 

func NewIRODSMessageCloseDataObjectReplicaRequest(desc int, sendNotification bool, updateSize bool, updateStatus bool, computeChecksum bool, preserveReplicaStateTable bool) *IRODSMessageCloseDataObjectReplicaRequest

NewIRODSMessageCloseDataObjectReplicaRequest creates a IRODSMessageCloseDataObjectReplicaRequest message

func (*IRODSMessageCloseDataObjectReplicaRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageCloseDataObjectReplicaRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageCloseDataObjectReplicaRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageCloseDataObjectReplicaRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageCloseDataObjectReplicaRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageCloseDataObjectReplicaRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageCloseDataObjectReplicaResponse added in v0.10.2 

type IRODSMessageCloseDataObjectReplicaResponse struct {
	// empty structure
	Result int
}

IRODSMessageCloseDataObjectReplicaResponse stores data object replica close response

func (*IRODSMessageCloseDataObjectReplicaResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageCloseDataObjectReplicaResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageCloseDataObjectReplicaResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageCloseDataObjectReplicaResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageCloseDataObjectRequest added in v0.10.2 

type IRODSMessageCloseDataObjectRequest IRODSMessageOpenedDataObjectRequest

IRODSMessageCloseDataObjectRequest stores data object close request

func NewIRODSMessageCloseDataObjectRequest added in v0.10.2 

func NewIRODSMessageCloseDataObjectRequest(desc int) *IRODSMessageCloseDataObjectRequest

NewIRODSMessageCloseDataObjectRequest creates a IRODSMessageCloseDataObjectRequest message

func (*IRODSMessageCloseDataObjectRequest) AddKeyVal added in v0.10.2 

func (msg *IRODSMessageCloseDataObjectRequest) AddKeyVal(key common.KeyWord, val string)

AddKeyVal adds a key-value pair

func (*IRODSMessageCloseDataObjectRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageCloseDataObjectRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageCloseDataObjectRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageCloseDataObjectRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageCloseDataObjectRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageCloseDataObjectRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageCloseDataObjectResponse added in v0.10.2 

type IRODSMessageCloseDataObjectResponse struct {
	// empty structure
	Result int
}

IRODSMessageCloseDataObjectResponse stores data object close response

func (*IRODSMessageCloseDataObjectResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageCloseDataObjectResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageCloseDataObjectResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageCloseDataObjectResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageCopyDataObjectRequest added in v0.10.2 

type IRODSMessageCopyDataObjectRequest struct {
	XMLName xml.Name `xml:"DataObjCopyInp_PI"`
	Paths   []IRODSMessageDataObjectRequest
}

IRODSMessageCopyDataObjectRequest stores data object copy request

func NewIRODSMessageCopyDataObjectRequest added in v0.10.2 

func NewIRODSMessageCopyDataObjectRequest(srcPath string, destPath string, force bool) *IRODSMessageCopyDataObjectRequest

NewIRODSMessageCopyDataObjectRequest creates a IRODSMessageCopyDataObjectRequest message

func (*IRODSMessageCopyDataObjectRequest) AddKeyVal added in v0.12.16 

func (msg *IRODSMessageCopyDataObjectRequest) AddKeyVal(key common.KeyWord, val string)

AddKeyVal adds a key-value pair

func (*IRODSMessageCopyDataObjectRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageCopyDataObjectRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageCopyDataObjectRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageCopyDataObjectRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageCopyDataObjectRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageCopyDataObjectRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageCopyDataObjectResponse added in v0.10.2 

type IRODSMessageCopyDataObjectResponse struct {
	// empty structure
	Result int
}

IRODSMessageCopyDataObjectResponse stores data object copy response

func (*IRODSMessageCopyDataObjectResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageCopyDataObjectResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageCopyDataObjectResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageCopyDataObjectResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageCreateDataObjectRequest added in v0.10.2 

type IRODSMessageCreateDataObjectRequest IRODSMessageDataObjectRequest

IRODSMessageCreateDataObjectRequest stores data object creation request

func NewIRODSMessageCreateDataObjectRequest added in v0.10.2 

func NewIRODSMessageCreateDataObjectRequest(path string, resource string, mode types.FileOpenMode, force bool) *IRODSMessageCreateDataObjectRequest

NewIRODSMessageCreateDataObjectRequest creates a IRODSMessageCreateDataObjectRequest message

func NewIRODSMessageCreateobjRequestWithKeyVals added in v0.9.4 

func NewIRODSMessageCreateobjRequestWithKeyVals(path string, resource string, mode types.FileOpenMode, force bool, keyvals map[string]string) *IRODSMessageCreateDataObjectRequest

NewIRODSMessageCreateobjRequestWithKeyVals creates a IRODSMessageCreateobjRequest message with given keyvals

func (*IRODSMessageCreateDataObjectRequest) AddKeyVal added in v0.10.2 

func (msg *IRODSMessageCreateDataObjectRequest) AddKeyVal(key common.KeyWord, val string)

AddKeyVal adds a key-value pair

func (*IRODSMessageCreateDataObjectRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageCreateDataObjectRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageCreateDataObjectRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageCreateDataObjectRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageCreateDataObjectRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageCreateDataObjectRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageCreateDataObjectResponse added in v0.10.2 

type IRODSMessageCreateDataObjectResponse struct {
	// empty structure
	FileDescriptor int
}

IRODSMessageCreateDataObjectResponse stores data object creation response

func (*IRODSMessageCreateDataObjectResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageCreateDataObjectResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageCreateDataObjectResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageCreateDataObjectResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessageCreateDataObjectResponse) GetFileDescriptor added in v0.10.2 

func (msg *IRODSMessageCreateDataObjectResponse) GetFileDescriptor() int

GetFileDescriptor returns file descriptor

type IRODSMessageDataObjectRequest 

type IRODSMessageDataObjectRequest struct {
	XMLName                  xml.Name                       `xml:"DataObjInp_PI"`
	Path                     string                         `xml:"objPath"`
	CreateMode               int                            `xml:"createMode"`
	OpenFlags                int                            `xml:"openFlags"`
	Offset                   int64                          `xml:"offset"`
	Size                     int64                          `xml:"dataSize"`
	Threads                  int                            `xml:"numThreads"`
	OperationType            int                            `xml:"oprType"`
	SpecialCollectionPointer *IRODSMessageSpecialCollection `xml:"SpecColl_PI"`
	KeyVals                  IRODSMessageSSKeyVal           `xml:"KeyValPair_PI"`
}

IRODSMessageDataObjectRequest ...

type IRODSMessageDisconnect 

type IRODSMessageDisconnect struct {
}

IRODSMessageDisconnect stores disconnect request

func NewIRODSMessageDisconnect 

func NewIRODSMessageDisconnect() *IRODSMessageDisconnect

NewIRODSMessageDisconnect creates a IRODSMessageAuthRequest message

func (*IRODSMessageDisconnect) FromMessage added in v0.10.2 

func (msg *IRODSMessageDisconnect) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessageDisconnect) GetMessage 

func (msg *IRODSMessageDisconnect) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageEndTransactionRequest added in v0.4.4 

type IRODSMessageEndTransactionRequest struct {
	XMLName  xml.Name `xml:"endTransactionInp_PI"`
	Action   string   `xml:"arg0"`
	Argument string   `xml:"arg1"` // unused
}

IRODSMessageEndTransactionRequest stores collection creation request

func NewIRODSMessageEndTransactionRequest added in v0.4.4 

func NewIRODSMessageEndTransactionRequest(commit bool) *IRODSMessageEndTransactionRequest

NewIRODSMessageEndTransactionRequest creates a IRODSMessageEndTransactionRequest message

func (*IRODSMessageEndTransactionRequest) FromBytes added in v0.4.4 

func (msg *IRODSMessageEndTransactionRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageEndTransactionRequest) GetBytes added in v0.4.4 

func (msg *IRODSMessageEndTransactionRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageEndTransactionRequest) GetMessage added in v0.4.4 

func (msg *IRODSMessageEndTransactionRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageEndTransactionResponse added in v0.4.4 

type IRODSMessageEndTransactionResponse struct {
	// empty structure
	Result int
}

IRODSMessageEndTransactionResponse stores end transaction response

func (*IRODSMessageEndTransactionResponse) CheckError added in v0.4.4 

func (msg *IRODSMessageEndTransactionResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageEndTransactionResponse) FromMessage added in v0.4.4 

func (msg *IRODSMessageEndTransactionResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageError added in v0.6.0 

type IRODSMessageError struct {
	XMLName xml.Name `xml:"RError_PI"`
	Count   int      `xml:"count"`
	Errors  []ErrorMsg
}

func NewIRODSMessageError added in v0.6.0 

func NewIRODSMessageError(status int, msg string) *IRODSMessageError

func (*IRODSMessageError) FromBytes added in v0.6.0 

func (msg *IRODSMessageError) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageError) FromMessage added in v0.6.0 

func (msg *IRODSMessageError) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessageError) GetBytes added in v0.6.0 

func (msg *IRODSMessageError) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageError) GetMessage added in v0.6.0 

func (msg *IRODSMessageError) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageExtractStructFileRequest added in v0.10.2 

type IRODSMessageExtractStructFileRequest struct {
	XMLName          xml.Name             `xml:"StructFileExtAndRegInp_PI"`
	Path             string               `xml:"objPath"`
	TargetCollection string               `xml:"collection"`
	OperationType    int                  `xml:"oprType"`
	Flags            int                  `xml:"flags"` // unused
	KeyVals          IRODSMessageSSKeyVal `xml:"KeyValPair_PI"`
}

IRODSMessageExtractStructFileRequest stores struct file extraction request

func NewIRODSMessageExtractStructFileRequest added in v0.10.2 

func NewIRODSMessageExtractStructFileRequest(path string, targetCollection string, resource string, dataType types.DataType, force bool, bulkReg bool) *IRODSMessageExtractStructFileRequest

NewIRODSMessageExtractStructFileRequest creates a IRODSMessageExtractstructfileRequest message

func (*IRODSMessageExtractStructFileRequest) AddKeyVal added in v0.10.2 

func (msg *IRODSMessageExtractStructFileRequest) AddKeyVal(key common.KeyWord, val string)

AddKeyVal adds a key-value pair

func (*IRODSMessageExtractStructFileRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageExtractStructFileRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageExtractStructFileRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageExtractStructFileRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageExtractStructFileRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageExtractStructFileRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageExtractStructFileResponse added in v0.10.2 

type IRODSMessageExtractStructFileResponse struct {
	// empty structure
	Result int
}

IRODSMessageExtractStructFileResponse stores struct file extraction response

func (*IRODSMessageExtractStructFileResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageExtractStructFileResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageExtractStructFileResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageExtractStructFileResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageGetDataObjectCompleteRequest added in v0.14.0 

type IRODSMessageGetDataObjectCompleteRequest IRODSMessageInt

IRODSMessageGetDataObjectCompleteRequest stores get data object complete request

func NewIRODSMessageGetDataObjectCompleteRequest added in v0.14.0 

func NewIRODSMessageGetDataObjectCompleteRequest(desc int) *IRODSMessageGetDataObjectCompleteRequest

NewIRODSMessageGetDataObjectCompleteRequest creates a IRODSMessageGetDataObjectCompleteRequest message

func (*IRODSMessageGetDataObjectCompleteRequest) FromBytes added in v0.14.0 

func (msg *IRODSMessageGetDataObjectCompleteRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageGetDataObjectCompleteRequest) GetBytes added in v0.14.0 

func (msg *IRODSMessageGetDataObjectCompleteRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageGetDataObjectCompleteRequest) GetMessage added in v0.14.0 

func (msg *IRODSMessageGetDataObjectCompleteRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageGetDataObjectCompleteResponse added in v0.14.0 

type IRODSMessageGetDataObjectCompleteResponse struct {
	// empty structure
	Result int
}

IRODSMessageGetDataObjectCompleteResponse stores get data object complete response

func (*IRODSMessageGetDataObjectCompleteResponse) CheckError added in v0.14.0 

func (msg *IRODSMessageGetDataObjectCompleteResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageGetDataObjectCompleteResponse) FromMessage added in v0.14.0 

func (msg *IRODSMessageGetDataObjectCompleteResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageGetDataObjectRequest added in v0.14.0 

type IRODSMessageGetDataObjectRequest IRODSMessageDataObjectRequest

IRODSMessageGetDataObjectRequest stores file get request

func NewIRODSMessageGetDataObjectRequest added in v0.14.0 

func NewIRODSMessageGetDataObjectRequest(path string, resource string, fileLength int64) *IRODSMessageGetDataObjectRequest

NewIRODSMessageGetDataObjectRequest creates a IRODSMessageGetDataObjectRequest message

func (*IRODSMessageGetDataObjectRequest) FromBytes added in v0.14.0 

func (msg *IRODSMessageGetDataObjectRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageGetDataObjectRequest) GetBytes added in v0.14.0 

func (msg *IRODSMessageGetDataObjectRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageGetDataObjectRequest) GetMessage added in v0.14.0 

func (msg *IRODSMessageGetDataObjectRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageGetDataObjectResponse added in v0.14.0 

type IRODSMessageGetDataObjectResponse IRODSMessagePortalResponse

IRODSMessageGetDataObjectResponse stores file get response

func (*IRODSMessageGetDataObjectResponse) CheckError added in v0.14.0 

func (msg *IRODSMessageGetDataObjectResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageGetDataObjectResponse) FromBytes added in v0.14.0 

func (msg *IRODSMessageGetDataObjectResponse) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageGetDataObjectResponse) FromMessage added in v0.14.0 

func (msg *IRODSMessageGetDataObjectResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessageGetDataObjectResponse) GetBytes added in v0.14.0 

func (msg *IRODSMessageGetDataObjectResponse) GetBytes() ([]byte, error)

GetBytes returns byte array

type IRODSMessageGetDataObjectStatRequest added in v0.10.2 

type IRODSMessageGetDataObjectStatRequest IRODSMessageDataObjectRequest

IRODSMessageGetDataObjectStatRequest stores file stat request

func (*IRODSMessageGetDataObjectStatRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageGetDataObjectStatRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageGetDataObjectStatRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageGetDataObjectStatRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageGetDataObjectStatRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageGetDataObjectStatRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageGetDataObjectStatResponse added in v0.10.2 

type IRODSMessageGetDataObjectStatResponse struct {
	XMLName                  xml.Name                       `xml:"RodsObjStat_PI"`
	Size                     int64                          `xml:"objSize"`
	Type                     int                            `xml:"objType"`
	DataMode                 int                            `xml:"dataMode"`
	DataID                   string                         `xml:"dataId"`
	CheckSum                 string                         `xml:"chksum"`
	Owner                    string                         `xml:"ownerName"`
	Zone                     string                         `xml:"ownerZone"`
	CreateTime               string                         `xml:"createTime"`
	ModifyTime               string                         `xml:"modifyTime"`
	SpecialCollectionPointer *IRODSMessageSpecialCollection `xml:"SpecColl_PI"`
	// stores error return
	Result int `xml:"-"`
}

IRODSMessageGetDataObjectStatResponse stores file stat response

func (*IRODSMessageGetDataObjectStatResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageGetDataObjectStatResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageGetDataObjectStatResponse) FromBytes added in v0.10.2 

func (msg *IRODSMessageGetDataObjectStatResponse) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageGetDataObjectStatResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageGetDataObjectStatResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessageGetDataObjectStatResponse) GetBytes added in v0.10.2 

func (msg *IRODSMessageGetDataObjectStatResponse) GetBytes() ([]byte, error)

GetBytes returns byte array

type IRODSMessageGetDescriptorInfoRequest added in v0.10.2 

type IRODSMessageGetDescriptorInfoRequest struct {
	FileDescriptor int `json:"fd"`
}

IRODSMessageGetDescriptorInfoRequest stores data object descriptor info. request

func NewIRODSMessageGetDescriptorInfoRequest added in v0.10.2 

func NewIRODSMessageGetDescriptorInfoRequest(desc int) *IRODSMessageGetDescriptorInfoRequest

NewIRODSMessageGetDescriptorInfoRequest creates a IRODSMessageDescriptorInfoRequest message

func (*IRODSMessageGetDescriptorInfoRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageGetDescriptorInfoRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageGetDescriptorInfoRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageGetDescriptorInfoRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageGetDescriptorInfoRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageGetDescriptorInfoRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageGetDescriptorInfoResponse added in v0.10.2 

type IRODSMessageGetDescriptorInfoResponse struct {
	L3DescriptorIndex       int                    `json:"l3descInx"`
	InUseFlag               bool                   `json:"in_use"`
	OperationType           int                    `json:"operation_type"`
	OpenType                int                    `json:"open_type"`
	OperationStatus         int                    `json:"operation_status"`
	ReplicationFlag         int                    `json:"data_object_input_replica_flag"`
	DataObjectInput         map[string]interface{} `json:"data_object_input"`
	DataObjectInfo          map[string]interface{} `json:"data_object_info"`
	OtherDataObjectInfo     map[string]interface{} `json:"other_data_object_info"`
	CopiesNeeded            int                    `json:"copies_needed"`
	BytesWritten            int64                  `json:"bytes_written"`
	DataSize                int64                  `json:"data_size"`
	ReplicaStatus           int                    `json:"replica_status"`
	ChecksumFlag            int                    `json:"checksum_flag"`
	SourceL1DescriptorIndex int                    `json:"source_l1_descriptor_index"`
	Checksum                string                 `json:"checksum"`
	RemoteL1DescriptorIndex int                    `json:"remote_l1_descriptor_index"`
	StageFlag               int                    `json:"stage_flag"`
	PurgeCacheFlag          int                    `json:"purge_cache_flag"`
	LockFileDescriptor      int                    `json:"lock_file_descriptor"`
	PluginData              map[string]interface{} `json:"plugin_data"`
	ReplicaDataObjectInfo   map[string]interface{} `json:"replication_data_object_info"`
	RemoteZoneHost          map[string]interface{} `json:"remote_zone_host"`
	InPDMO                  string                 `json:"in_pdmo"`
	ReplicaToken            string                 `json:"replica_token"`

	// stores error return
	Result int `json:"-"`
}

IRODSMessageGetDescriptorInfoResponse stores data object descriptor info. response

func (*IRODSMessageGetDescriptorInfoResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageGetDescriptorInfoResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageGetDescriptorInfoResponse) FromBytes added in v0.10.2 

func (msg *IRODSMessageGetDescriptorInfoResponse) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageGetDescriptorInfoResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageGetDescriptorInfoResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageGetFileStatRequest added in v0.10.2 

type IRODSMessageGetFileStatRequest struct {
	XMLName           xml.Name         `xml:"fileStatInp_PI"`
	Host              IRODSMessageHost `xml:"RHostAddr_PI"`
	Path              string           `xml:"fileName"`
	ResourceHierarchy string           `xml:"rescHier"`
	ObjectPath        string           `xml:"objPath"`
	ResourceID        int64            `xml:"rescId"`
}

IRODSMessageGetFileStatRequest stores file stat request

func NewIRODSMessageGetFileStatRequest added in v0.10.2 

func NewIRODSMessageGetFileStatRequest(resource *types.IRODSResource, obj *types.IRODSDataObject, replica *types.IRODSReplica) (*IRODSMessageGetFileStatRequest, error)

NewIRODSMessageGetFileStatRequest creates a IRODSMessageGetFileStatRequest message

func (*IRODSMessageGetFileStatRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageGetFileStatRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageGetFileStatRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageGetFileStatRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageGetFileStatRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageGetFileStatRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageGetFileStatResponse added in v0.10.2 

type IRODSMessageGetFileStatResponse struct {
	XMLName    xml.Name `xml:"RODS_STAT_T_PI"`
	Size       int64    `xml:"st_size"`
	Dev        int      `xml:"st_dev"`
	Ino        int      `xml:"st_ino"`
	Mode       int      `xml:"st_mode"`
	Links      int      `xml:"st_nlink"`
	UID        int      `xml:"st_uid"`
	GID        int      `xml:"st_gid"`
	Rdev       int      `xml:"st_rdev"`
	AccessTime int      `xml:"st_atim"`
	ModifyTime int      `xml:"st_mtim"`
	ChangeTime int      `xml:"st_ctim"`
	BlkSize    int      `xml:"st_blksize"`
	Blocks     int      `xml:"st_blocks"`

	// stores error return
	Result int `xml:"-"`
}

IRODSMessageGetFileStatResponse stores data object read response

func (*IRODSMessageGetFileStatResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageGetFileStatResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageGetFileStatResponse) FromBytes added in v0.10.2 

func (msg *IRODSMessageGetFileStatResponse) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageGetFileStatResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageGetFileStatResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessageGetFileStatResponse) GetBytes added in v0.10.2 

func (msg *IRODSMessageGetFileStatResponse) GetBytes() ([]byte, error)

GetBytes returns byte array

type IRODSMessageGetProcessstatRequest added in v0.10.2 

type IRODSMessageGetProcessstatRequest struct {
	XMLName xml.Name             `xml:"ProcStatInp_PI"`
	Address string               `xml:"addr"`
	Zone    string               `xml:"rodsZone"`
	KeyVals IRODSMessageSSKeyVal `xml:"KeyValPair_PI"`
}

IRODSMessageGetProcessstatRequest stores process stat request

func NewIRODSMessageGetProcessstatRequest added in v0.10.2 

func NewIRODSMessageGetProcessstatRequest(address string, zone string) *IRODSMessageGetProcessstatRequest

NewIRODSMessageGetProcessstatRequest creates a IRODSMessageGetProcessstatRequest message

func (*IRODSMessageGetProcessstatRequest) AddKeyVal added in v0.10.2 

func (msg *IRODSMessageGetProcessstatRequest) AddKeyVal(key common.KeyWord, val string)

AddKeyVal adds a key-value pair

func (*IRODSMessageGetProcessstatRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageGetProcessstatRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageGetProcessstatRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageGetProcessstatRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageGetProcessstatRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageGetProcessstatRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageHeader 

type IRODSMessageHeader struct {
	XMLName    xml.Name    `xml:"MsgHeader_PI"`
	Type       MessageType `xml:"type"`
	MessageLen uint32      `xml:"msgLen"`
	ErrorLen   uint32      `xml:"errorLen"`
	BsLen      uint32      `xml:"bsLen"`
	IntInfo    int32       `xml:"intInfo"`
}

IRODSMessageHeader defines a message header

func MakeIRODSMessageHeader 

func MakeIRODSMessageHeader(messageType MessageType, messageLen uint32, errorLen uint32, bsLen uint32, intInfo int32) *IRODSMessageHeader

MakeIRODSMessageHeader makes a message header

func (*IRODSMessageHeader) FromBytes 

func (header *IRODSMessageHeader) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageHeader) GetBytes 

func (header *IRODSMessageHeader) GetBytes() ([]byte, error)

GetBytes returns byte array

type IRODSMessageHost added in v0.4.0 

type IRODSMessageHost struct {
	XMLName  xml.Name `xml:"RHostAddr_PI"`
	Addr     string   `xml:"hostAddr"`
	Zone     string   `xml:"rodsZone"`
	Port     int      `xml:"port"`
	DummyInt int      `xml:"dummyInt"`
}

IRODSMessageHost stores startup message

func NewIRODSMessageHost added in v0.4.0 

func NewIRODSMessageHost(resource *types.IRODSResource) (*IRODSMessageHost, error)

NewIRODSMessageHost creates a IRODSMessageHost message

func (*IRODSMessageHost) FromBytes added in v0.4.0 

func (msg *IRODSMessageHost) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageHost) GetBytes added in v0.4.0 

func (msg *IRODSMessageHost) GetBytes() ([]byte, error)

GetBytes returns byte array

type IRODSMessageIIKeyVal 

type IRODSMessageIIKeyVal struct {
	XMLName xml.Name `xml:"InxIvalPair_PI"`
	Length  int      `xml:"iiLen"`
	Keys    []int    `xml:"inx,omitempty"`
	Values  []int    `xml:"ivalue,omitempty"`
}

IRODSMessageIIKeyVal ..

func NewIRODSMessageIIKeyVal 

func NewIRODSMessageIIKeyVal() *IRODSMessageIIKeyVal

NewIRODSMessageIIKeyVal creates a new IRODSMessageIIKeyVal

func (*IRODSMessageIIKeyVal) Add 

func (kv *IRODSMessageIIKeyVal) Add(key int, val int)

Add adds a key-val pair

type IRODSMessageISKeyVal 

type IRODSMessageISKeyVal struct {
	XMLName xml.Name                `xml:"InxValPair_PI"`
	Length  int                     `xml:"isLen"`
	Keys    []int                   `xml:"inx,omitempty"`
	Values  []IRODSMessageRawString `xml:"svalue,omitempty"`
}

IRODSMessageISKeyVal ..

func NewIRODSMessageISKeyVal 

func NewIRODSMessageISKeyVal() *IRODSMessageISKeyVal

NewIRODSMessageISKeyVal creates a new IRODSMessageISKeyVal

func (*IRODSMessageISKeyVal) Add 

func (kv *IRODSMessageISKeyVal) Add(key int, val string)

Add adds a key-val pair

type IRODSMessageInt added in v0.14.0 

type IRODSMessageInt struct {
	XMLName xml.Name `xml:"INT_PI"`
	Value   int      `xml:"myInt"`
}

IRODSMessageInt stores int message

func NewIRODSMessageInt added in v0.14.0 

func NewIRODSMessageInt(intValue int) (*IRODSMessageInt, error)

NewIRODSMessageInt creates a IRODSMessageInt message

func (*IRODSMessageInt) FromBytes added in v0.14.0 

func (msg *IRODSMessageInt) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageInt) GetBytes added in v0.14.0 

func (msg *IRODSMessageInt) GetBytes() ([]byte, error)

GetBytes returns byte array

type IRODSMessageLockDataObjectRequest added in v0.12.8 

type IRODSMessageLockDataObjectRequest IRODSMessageDataObjectRequest

IRODSMessageLockDataObjectRequest stores data object lock request

func NewIRODSMessageLockDataObjectRequest added in v0.12.8 

func NewIRODSMessageLockDataObjectRequest(path string, lockType types.DataObjectLockType, lockCommand types.DataObjectLockCommand) *IRODSMessageLockDataObjectRequest

NewIRODSMessageLockDataObjectRequest creates a IRODSMessageLockDataObjectRequest message

func NewIRODSMessageReadLockDataObjectRequest added in v0.12.8 

func NewIRODSMessageReadLockDataObjectRequest(path string, lockCommand types.DataObjectLockCommand) *IRODSMessageLockDataObjectRequest

NewIRODSMessageReadLockDataObjectRequest creates a IRODSMessageLockDataObjectRequest message

func NewIRODSMessageWriteLockDataObjectRequest added in v0.12.8 

func NewIRODSMessageWriteLockDataObjectRequest(path string, lockCommand types.DataObjectLockCommand) *IRODSMessageLockDataObjectRequest

NewIRODSMessageWriteLockDataObjectRequest creates a IRODSMessageLockDataObjectRequest message

func (*IRODSMessageLockDataObjectRequest) AddKeyVal added in v0.12.8 

func (msg *IRODSMessageLockDataObjectRequest) AddKeyVal(key common.KeyWord, val string)

AddKeyVal adds a key-value pair

func (*IRODSMessageLockDataObjectRequest) FromBytes added in v0.12.8 

func (msg *IRODSMessageLockDataObjectRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageLockDataObjectRequest) GetBytes added in v0.12.8 

func (msg *IRODSMessageLockDataObjectRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageLockDataObjectRequest) GetMessage added in v0.12.8 

func (msg *IRODSMessageLockDataObjectRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageLockDataObjectResponse added in v0.12.8 

type IRODSMessageLockDataObjectResponse struct {
	// empty structure
	FileDescriptor int
}

IRODSMessageLockDataObjectResponse stores data object lock response

func (*IRODSMessageLockDataObjectResponse) CheckError added in v0.12.8 

func (msg *IRODSMessageLockDataObjectResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageLockDataObjectResponse) FromMessage added in v0.12.8 

func (msg *IRODSMessageLockDataObjectResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessageLockDataObjectResponse) GetFileDescriptor added in v0.12.8 

func (msg *IRODSMessageLockDataObjectResponse) GetFileDescriptor() int

GetFileDescriptor returns file descriptor

type IRODSMessageMakeCollectionRequest added in v0.10.2 

type IRODSMessageMakeCollectionRequest struct {
	XMLName       xml.Name             `xml:"CollInpNew_PI"`
	Name          string               `xml:"collName"`
	Flags         int                  `xml:"flags"`   // unused
	OperationType int                  `xml:"oprType"` // unused
	KeyVals       IRODSMessageSSKeyVal `xml:"KeyValPair_PI"`
}

IRODSMessageMakeCollectionRequest stores collection creation request

func NewIRODSMessageMakeCollectionRequest added in v0.10.2 

func NewIRODSMessageMakeCollectionRequest(name string, recurse bool) *IRODSMessageMakeCollectionRequest

NewIRODSMessageMakeCollectionRequest creates a IRODSMessageMakeCollectionRequest message

func (*IRODSMessageMakeCollectionRequest) AddKeyVal added in v0.10.2 

func (msg *IRODSMessageMakeCollectionRequest) AddKeyVal(key common.KeyWord, val string)

AddKeyVal adds a key-value pair

func (*IRODSMessageMakeCollectionRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageMakeCollectionRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageMakeCollectionRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageMakeCollectionRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageMakeCollectionRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageMakeCollectionRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageMakeCollectionResponse added in v0.10.2 

type IRODSMessageMakeCollectionResponse struct {
	// empty structure
	Result int
}

IRODSMessageMakeCollectionResponse stores collection creation response

func (*IRODSMessageMakeCollectionResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageMakeCollectionResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageMakeCollectionResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageMakeCollectionResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageModifyAccessRequest added in v0.10.2 

type IRODSMessageModifyAccessRequest struct {
	XMLName       xml.Name `xml:"modAccessControlInp_PI"`
	RecursiveFlag int      `xml:"recursiveFlag"`
	AccessLevel   string   `xml:"accessLevel"`
	UserName      string   `xml:"userName"`
	Zone          string   `xml:"zone"`
	Path          string   `xml:"path"`
}

IRODSMessageModifyAccessRequest stores alter access control request

func NewIRODSMessageModifyAccessRequest added in v0.10.2 

func NewIRODSMessageModifyAccessRequest(accessLevel, user, zone, path string, recursive, asAdmin bool) *IRODSMessageModifyAccessRequest

NewIRODSMessageModifyAccessRequest creates a IRODSMessageModAccessRequest message for altering the access control list of a object or collection.

func (*IRODSMessageModifyAccessRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageModifyAccessRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageModifyAccessRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageModifyAccessRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageModifyAccessRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageModifyAccessRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageModifyAccessResponse added in v0.10.2 

type IRODSMessageModifyAccessResponse struct {
	// empty structure
	Result int
}

IRODSMessageModifyAccessResponse stores alter metadata response

func (*IRODSMessageModifyAccessResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageModifyAccessResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageModifyAccessResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageModifyAccessResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageModifyCollectionRequest added in v0.10.2 

type IRODSMessageModifyCollectionRequest IRODSMessageMakeCollectionRequest

IRODSMessageModifyCollectionRequest stores mod coll request

func NewIRODSMessageModifyCollectionRequest added in v0.10.2 

func NewIRODSMessageModifyCollectionRequest(name string) *IRODSMessageModifyCollectionRequest

NewIRODSMessageModifyCollectionRequest creates a IRODSMessageModifyCollectionRequest message

func (*IRODSMessageModifyCollectionRequest) AddKeyVal added in v0.10.2 

func (msg *IRODSMessageModifyCollectionRequest) AddKeyVal(key common.KeyWord, val string)

AddKeyVal adds a key-value pair

func (*IRODSMessageModifyCollectionRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageModifyCollectionRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageModifyCollectionRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageModifyCollectionRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageModifyCollectionRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageModifyCollectionRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageModifyCollectionResponse added in v0.10.2 

type IRODSMessageModifyCollectionResponse struct {
	// empty structure
	Result int
}

IRODSMessageModifyCollectionResponse stores alter metadata response

func (*IRODSMessageModifyCollectionResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageModifyCollectionResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageModifyCollectionResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageModifyCollectionResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageModifyMetadataRequest added in v0.10.2 

type IRODSMessageModifyMetadataRequest struct {
	XMLName      xml.Name `xml:"ModAVUMetadataInp_PI"`
	Operation    string   `xml:"arg0"` // add, adda, rm, rmw, rmi, cp, mod, set
	ItemType     string   `xml:"arg1"` // -d, -D, -c, -C, -r, -R, -u, -U
	ItemName     string   `xml:"arg2"`
	AttrName     string   `xml:"arg3"`
	AttrValue    string   `xml:"arg4"`
	AttrUnits    string   `xml:"arg5"`
	NewAttrName  string   `xml:"arg6"` // new attr name (for mod)
	NewAttrValue string   `xml:"arg7"` // new attr value (for mod)
	NewAttrUnits string   `xml:"arg8"` // new attr unit (for mod)
	Arg9         string   `xml:"arg9"` // unused
}

IRODSMessageModifyMetadataRequest stores alter metadata request

func NewIRODSMessageAddMetadataRequest added in v0.2.0 

func NewIRODSMessageAddMetadataRequest(itemType types.IRODSMetaItemType, itemName string, metadata *types.IRODSMeta) *IRODSMessageModifyMetadataRequest

NewIRODSMessageAddMetadataRequest creates a IRODSMessageModMetaRequest message for adding a metadata AVU on some item. metadata.AVUID is ignored

func NewIRODSMessageRemoveMetadataByIDRequest added in v0.2.0 

func NewIRODSMessageRemoveMetadataByIDRequest(itemType types.IRODSMetaItemType, itemName string, AVUID int64) *IRODSMessageModifyMetadataRequest

NewIRODSMessageRemoveMetadataByIDRequest creates a IRODSMessageModMetaRequest message for removing a metadata AVU by its AVUID.

func NewIRODSMessageRemoveMetadataRequest added in v0.2.0 

func NewIRODSMessageRemoveMetadataRequest(itemType types.IRODSMetaItemType, itemName string, metadata *types.IRODSMeta) *IRODSMessageModifyMetadataRequest

NewIRODSMessageRemoveMetadataRequest creates a IRODSMessageModMetaRequest message for removing a metadata AVU. metadata.AVUID is ignored, the AVU is queried by its name, value and unit.

func NewIRODSMessageRemoveMetadataWildcardRequest added in v0.4.5 

func NewIRODSMessageRemoveMetadataWildcardRequest(itemType types.IRODSMetaItemType, itemName, attName string) *IRODSMessageModifyMetadataRequest

NewIRODSMessageRemoveMetadataWildcardRequest creates a IRODSMessageModMetaRequest message for removing a metadata AVU by itemName and attributeValue.

func NewIRODSMessageReplaceMetadataRequest added in v0.2.0 

func NewIRODSMessageReplaceMetadataRequest(itemType types.IRODSMetaItemType, itemName string, oldMetadata *types.IRODSMeta, newMetadata *types.IRODSMeta) *IRODSMessageModifyMetadataRequest

NewIRODSMessageReplaceMetadataRequest creates a IRODSMessageModMetaRequest message for replacing a metadata AVU. oldMetadata.AVUID and newMetadata.AVUID are ignored, the old AVU is queried by its name, value and unit.

func NewIRODSMessageSetMetadataRequest added in v0.2.0 

func NewIRODSMessageSetMetadataRequest(itemType types.IRODSMetaItemType, itemName string, metadata *types.IRODSMeta) *IRODSMessageModifyMetadataRequest

NewIRODSMessageSetMetadataRequest creates a IRODSMessageModMetaRequest message for changing the first metadata AVU on the given item with a matching attribute name to the given value an units. metadata.AVUID is ignored.

func (*IRODSMessageModifyMetadataRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageModifyMetadataRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageModifyMetadataRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageModifyMetadataRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageModifyMetadataRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageModifyMetadataRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageModifyMetadataResponse added in v0.10.2 

type IRODSMessageModifyMetadataResponse struct {
	// empty structure
	Result int
}

IRODSMessageModifyMetadataResponse stores alter metadata response

func (*IRODSMessageModifyMetadataResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageModifyMetadataResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageModifyMetadataResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageModifyMetadataResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageMoveCollectionRequest added in v0.10.2 

type IRODSMessageMoveCollectionRequest struct {
	XMLName xml.Name `xml:"DataObjCopyInp_PI"`
	Paths   []IRODSMessageDataObjectRequest
}

IRODSMessageMoveCollectionRequest stores collection move request

func NewIRODSMessageMoveCollectionRequest added in v0.10.2 

func NewIRODSMessageMoveCollectionRequest(srcPath string, destPath string) *IRODSMessageMoveCollectionRequest

NewIRODSMessageMoveCollectionRequest creates a IRODSMessageMvcolRequest message

func (*IRODSMessageMoveCollectionRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageMoveCollectionRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageMoveCollectionRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageMoveCollectionRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageMoveCollectionRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageMoveCollectionRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageMoveCollectionResponse added in v0.10.2 

type IRODSMessageMoveCollectionResponse struct {
	// empty structure
	Result int
}

IRODSMessageMoveCollectionResponse stores collection move response

func (*IRODSMessageMoveCollectionResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageMoveCollectionResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageMoveCollectionResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageMoveCollectionResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageMoveDataObjectRequest added in v0.10.2 

type IRODSMessageMoveDataObjectRequest struct {
	XMLName xml.Name `xml:"DataObjCopyInp_PI"`
	Paths   []IRODSMessageDataObjectRequest
}

IRODSMessageMoveDataObjectRequest stores data object move request

func NewIRODSMessageMoveDataObjectRequest added in v0.10.2 

func NewIRODSMessageMoveDataObjectRequest(srcPath string, destPath string) *IRODSMessageMoveDataObjectRequest

NewIRODSMessageMoveDataObjectRequest creates a IRODSMessageMoveDataObjectRequest message

func (*IRODSMessageMoveDataObjectRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageMoveDataObjectRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageMoveDataObjectRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageMoveDataObjectRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageMoveDataObjectRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageMoveDataObjectRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageMoveDataObjectResponse added in v0.10.2 

type IRODSMessageMoveDataObjectResponse struct {
	// empty structure
	Result int
}

IRODSMessageMoveDataObjectResponse stores data object move response

func (*IRODSMessageMoveDataObjectResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageMoveDataObjectResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageMoveDataObjectResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageMoveDataObjectResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageOpenDataObjectRequest added in v0.10.2 

type IRODSMessageOpenDataObjectRequest IRODSMessageDataObjectRequest

IRODSMessageOpenDataObjectRequest stores data object open request

func NewIRODSMessageOpenDataObjectRequest added in v0.10.2 

func NewIRODSMessageOpenDataObjectRequest(path string, resource string, mode types.FileOpenMode) *IRODSMessageOpenDataObjectRequest

NewIRODSMessageOpenDataObjectRequest creates a IRODSMessageOpenDataObjectRequest message

func NewIRODSMessageOpenobjRequestForPutParallel added in v0.12.5 

func NewIRODSMessageOpenobjRequestForPutParallel(path string, resource string, mode types.FileOpenMode, oper common.OperationType, threadNum int, dataSize int64) *IRODSMessageOpenDataObjectRequest

NewIRODSMessageOpenobjRequestForPutParallel ...

func NewIRODSMessageOpenobjRequestWithOperation 

func NewIRODSMessageOpenobjRequestWithOperation(path string, resource string, mode types.FileOpenMode, oper common.OperationType) *IRODSMessageOpenDataObjectRequest

NewIRODSMessageOpenobjRequestWithOperation ...

func NewIRODSMessageOpenobjRequestWithReplicaToken added in v0.5.8 

func NewIRODSMessageOpenobjRequestWithReplicaToken(path string, mode types.FileOpenMode, resourceHierarchy string, replicaToken string, threadNum int, dataSize int64) *IRODSMessageOpenDataObjectRequest

NewIRODSMessageOpenobjRequestWithReplicaToken creates a IRODSMessageOpenobjRequest message

func (*IRODSMessageOpenDataObjectRequest) AddKeyVal added in v0.10.2 

func (msg *IRODSMessageOpenDataObjectRequest) AddKeyVal(key common.KeyWord, val string)

AddKeyVal adds a key-value pair

func (*IRODSMessageOpenDataObjectRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageOpenDataObjectRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageOpenDataObjectRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageOpenDataObjectRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageOpenDataObjectRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageOpenDataObjectRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageOpenDataObjectResponse added in v0.10.2 

type IRODSMessageOpenDataObjectResponse struct {
	// empty structure
	FileDescriptor int
}

IRODSMessageOpenDataObjectResponse stores data object open response

func (*IRODSMessageOpenDataObjectResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageOpenDataObjectResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageOpenDataObjectResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageOpenDataObjectResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessageOpenDataObjectResponse) GetFileDescriptor added in v0.10.2 

func (msg *IRODSMessageOpenDataObjectResponse) GetFileDescriptor() int

GetFileDescriptor returns file descriptor

type IRODSMessageOpenedDataObjectRequest 

type IRODSMessageOpenedDataObjectRequest struct {
	XMLName        xml.Name             `xml:"OpenedDataObjInp_PI"`
	FileDescriptor int                  `xml:"l1descInx"`
	Size           int64                `xml:"len"`
	Whence         int                  `xml:"whence"`
	OperationType  int                  `xml:"oprType"`
	Offset         int64                `xml:"offset"`
	BytesWritten   int64                `xml:"bytesWritten"`
	KeyVals        IRODSMessageSSKeyVal `xml:"KeyValPair_PI"`
}

IRODSMessageOpenedDataObjectRequest ...

type IRODSMessageOperationCompleteRequest added in v0.14.0 

type IRODSMessageOperationCompleteRequest IRODSMessageInt

IRODSMessageOperationCompleteRequest stores operation complete request

func NewIRODSMessageOperationCompleteRequest added in v0.14.0 

func NewIRODSMessageOperationCompleteRequest(value int) *IRODSMessageOperationCompleteRequest

NewIRODSMessageOperationCompleteRequest creates a IRODSMessageOperationCompleteRequest message

func (*IRODSMessageOperationCompleteRequest) FromBytes added in v0.14.0 

func (msg *IRODSMessageOperationCompleteRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageOperationCompleteRequest) GetBytes added in v0.14.0 

func (msg *IRODSMessageOperationCompleteRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageOperationCompleteRequest) GetMessage added in v0.14.0 

func (msg *IRODSMessageOperationCompleteRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageOperationCompleteResponse added in v0.14.0 

type IRODSMessageOperationCompleteResponse struct {
	// empty structure
	Result int
}

IRODSMessageOperationCompleteResponse stores operation complete response

func (*IRODSMessageOperationCompleteResponse) CheckError added in v0.14.0 

func (msg *IRODSMessageOperationCompleteResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageOperationCompleteResponse) FromMessage added in v0.14.0 

func (msg *IRODSMessageOperationCompleteResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessagePamAuthRequest added in v0.2.0 

type IRODSMessagePamAuthRequest struct {
	XMLName  xml.Name `xml:"pamAuthRequestInp_PI"`
	Username string   `xml:"pamUser"`
	Password string   `xml:"pamPassword"`
	TTL      int      `xml:"timeToLive"`
}

IRODSMessagePamAuthRequest stores auth response

func NewIRODSMessagePamAuthRequest added in v0.2.0 

func NewIRODSMessagePamAuthRequest(username, password string, ttl int) *IRODSMessagePamAuthRequest

NewIRODSMessagePamAuthRequest creates a IRODSMessagePamAuthRequest message

func (*IRODSMessagePamAuthRequest) FromBytes added in v0.2.0 

func (msg *IRODSMessagePamAuthRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessagePamAuthRequest) GetBytes added in v0.2.0 

func (msg *IRODSMessagePamAuthRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessagePamAuthRequest) GetMessage added in v0.2.0 

func (msg *IRODSMessagePamAuthRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessagePamAuthResponse added in v0.2.0 

type IRODSMessagePamAuthResponse struct {
	XMLName           xml.Name `xml:"pamAuthRequestOut_PI"`
	GeneratedPassword string   `xml:"irodsPamPassword"`
}

IRODSMessagePamAuthResponse stores auth challenge

func (*IRODSMessagePamAuthResponse) FromBytes added in v0.2.0 

func (msg *IRODSMessagePamAuthResponse) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessagePamAuthResponse) FromMessage added in v0.2.0 

func (msg *IRODSMessagePamAuthResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessagePamAuthResponse) GetBytes added in v0.2.0 

func (msg *IRODSMessagePamAuthResponse) GetBytes() ([]byte, error)

GetBytes returns byte array

type IRODSMessagePortList added in v0.14.0 

type IRODSMessagePortList struct {
	XMLName      xml.Name `xml:"PortList_PI"`
	Port         int      `xml:"portNum"`
	Cookie       int      `xml:"cookie"`
	ServerSocket int      `xml:"sock"` // server's sock number
	WindowSize   int      `xml:"windowSize"`
	HostAddress  string   `xml:"hostAddr"`
}

type IRODSMessagePortalResponse added in v0.14.0 

type IRODSMessagePortalResponse struct {
	XMLName        xml.Name              `xml:"PortalOprOut_PI"`
	Status         int                   `xml:"status"`
	FileDescriptor int                   `xml:"l1descInx"`
	Threads        int                   `xml:"numThreads"`
	CheckSum       string                `xml:"chksum"`
	PortList       *IRODSMessagePortList `xml:"PortList_PI"`
	// stores error return
	// error if result < 0
	// data is included if result == 0
	// any value >= 0 is fine
	Result int `xml:"-"`
}

IRODSMessagePortalResponse stores portal response

type IRODSMessagePutDataObjectRequest added in v0.14.0 

type IRODSMessagePutDataObjectRequest IRODSMessageDataObjectRequest

IRODSMessagePutDataObjectRequest stores file put request

func NewIRODSMessagePutDataObjectRequest added in v0.14.0 

func NewIRODSMessagePutDataObjectRequest(path string, resource string, fileLength int64) *IRODSMessagePutDataObjectRequest

NewIRODSMessagePutDataObjectRequest creates a IRODSMessagePutDataObjectRequest message

func (*IRODSMessagePutDataObjectRequest) FromBytes added in v0.14.0 

func (msg *IRODSMessagePutDataObjectRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessagePutDataObjectRequest) GetBytes added in v0.14.0 

func (msg *IRODSMessagePutDataObjectRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessagePutDataObjectRequest) GetMessage added in v0.14.0 

func (msg *IRODSMessagePutDataObjectRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessagePutDataObjectResponse added in v0.14.0 

type IRODSMessagePutDataObjectResponse IRODSMessagePortalResponse

IRODSMessagePutDataObjectResponse stores file put response

func (*IRODSMessagePutDataObjectResponse) CheckError added in v0.14.0 

func (msg *IRODSMessagePutDataObjectResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessagePutDataObjectResponse) FromBytes added in v0.14.0 

func (msg *IRODSMessagePutDataObjectResponse) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessagePutDataObjectResponse) FromMessage added in v0.14.0 

func (msg *IRODSMessagePutDataObjectResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessagePutDataObjectResponse) GetBytes added in v0.14.0 

func (msg *IRODSMessagePutDataObjectResponse) GetBytes() ([]byte, error)

GetBytes returns byte array

type IRODSMessageQueryRequest added in v0.10.2 

type IRODSMessageQueryRequest struct {
	XMLName           xml.Name             `xml:"GenQueryInp_PI"`
	MaxRows           int                  `xml:"maxRows"`
	ContinueIndex     int                  `xml:"continueInx"`       // 1 for continueing, 0 for end
	PartialStartIndex int                  `xml:"partialStartIndex"` // unknown
	Options           int                  `xml:"options"`
	KeyVals           IRODSMessageSSKeyVal `xml:"KeyValPair_PI"`
	Selects           IRODSMessageIIKeyVal `xml:"InxIvalPair_PI"`
	Conditions        IRODSMessageISKeyVal `xml:"InxValPair_PI"`
}

IRODSMessageQueryRequest stores query

func NewIRODSMessageQueryRequest added in v0.10.2 

func NewIRODSMessageQueryRequest(maxRows int, continueIndex int, partialStartIndex int, options int) *IRODSMessageQueryRequest

NewIRODSMessageQueryRequest creates a IRODSMessageQueryRequest message

func (*IRODSMessageQueryRequest) AddCondition added in v0.10.2 

func (msg *IRODSMessageQueryRequest) AddCondition(key common.ICATColumnNumber, val string)

AddCondition adds a condition

func (*IRODSMessageQueryRequest) AddKeyVal added in v0.10.2 

func (msg *IRODSMessageQueryRequest) AddKeyVal(key common.KeyWord, val string)

AddKeyVal adds a key-value pair

func (*IRODSMessageQueryRequest) AddSelect added in v0.10.2 

func (msg *IRODSMessageQueryRequest) AddSelect(key common.ICATColumnNumber, val int)

AddSelect adds a column to select

func (*IRODSMessageQueryRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageQueryRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageQueryRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageQueryRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageQueryRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageQueryRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageQueryResponse added in v0.10.2 

type IRODSMessageQueryResponse struct {
	XMLName        xml.Name                `xml:"GenQueryOut_PI"`
	RowCount       int                     `xml:"rowCnt"`
	AttributeCount int                     `xml:"attriCnt"`
	ContinueIndex  int                     `xml:"continueInx"`
	TotalRowCount  int                     `xml:"totalRowCount"`
	SQLResult      []IRODSMessageSQLResult `xml:"SqlResult_PI"`

	// stores error result
	Result int `xml:"-"`
}

IRODSMessageQueryResponse stores query result

func (*IRODSMessageQueryResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageQueryResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageQueryResponse) FromBytes added in v0.10.2 

func (msg *IRODSMessageQueryResponse) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageQueryResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageQueryResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessageQueryResponse) GetBytes added in v0.10.2 

func (msg *IRODSMessageQueryResponse) GetBytes() ([]byte, error)

GetBytes returns byte array

type IRODSMessageQuerySpecialCollection added in v0.10.2 

type IRODSMessageQuerySpecialCollection IRODSMessageDataObjectRequest

func (*IRODSMessageQuerySpecialCollection) FromBytes added in v0.10.2 

func (msg *IRODSMessageQuerySpecialCollection) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageQuerySpecialCollection) FromMessage added in v0.10.2 

func (msg *IRODSMessageQuerySpecialCollection) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessageQuerySpecialCollection) GetBytes added in v0.10.2 

func (msg *IRODSMessageQuerySpecialCollection) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageQuerySpecialCollection) GetMessage added in v0.10.2 

func (msg *IRODSMessageQuerySpecialCollection) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageQuerySpecificRequest added in v0.10.2 

type IRODSMessageQuerySpecificRequest struct {
	// str *sql; str *arg1; str *arg2; str *arg3; str *arg4; str *arg5; str *arg6; str *arg7; str *arg8; str *arg9; str *arg10; int maxRows; int continueInx; int rowOffset; int options; struct KeyValPair_PI;
	XMLName       xml.Name             `xml:"specificQueryInp_PI"`
	SQL           string               `xml:"sql"`
	Arg1          string               `xml:"arg1"`
	Arg2          string               `xml:"arg2"`
	Arg3          string               `xml:"arg3"`
	Arg4          string               `xml:"arg4"`
	Arg5          string               `xml:"arg5"`
	Arg6          string               `xml:"arg6"`
	Arg7          string               `xml:"arg7"`
	Arg8          string               `xml:"arg8"`
	Arg9          string               `xml:"arg9"`
	Arg10         string               `xml:"arg10"`
	MaxRows       int                  `xml:"maxRows"`
	ContinueIndex int                  `xml:"continueInx"` // 1 for continueing, 0 for end
	RowOffset     int                  `xml:"rowOffset"`
	Options       int                  `xml:"options"`
	KeyVals       IRODSMessageSSKeyVal `xml:"KeyValPair_PI"`
}

IRODSMessageQuerySpecificRequest stores specific query request

func NewIRODSMessageQuerySpecificRequest added in v0.10.2 

func NewIRODSMessageQuerySpecificRequest(sqlQuery string, args []string, maxRows int, continueIndex int, rowOffset int, options int) *IRODSMessageQuerySpecificRequest

NewIRODSMessageQuerySpecificRequest creates a IRODSMessageQuerySpecificRequest message

func (*IRODSMessageQuerySpecificRequest) AddKeyVal added in v0.10.2 

func (msg *IRODSMessageQuerySpecificRequest) AddKeyVal(key common.KeyWord, val string)

AddKeyVal adds a key-value pair

func (*IRODSMessageQuerySpecificRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageQuerySpecificRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageQuerySpecificRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageQuerySpecificRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageQuerySpecificRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageQuerySpecificRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageRawString 

type IRODSMessageRawString struct {
	Value string `xml:",innerxml"`
}

IRODSMessageRawString ...

type IRODSMessageReadDataObjectRequest added in v0.10.2 

type IRODSMessageReadDataObjectRequest IRODSMessageOpenedDataObjectRequest

IRODSMessageReadDataObjectRequest stores data object read request

func NewIRODSMessageReadDataObjectRequest added in v0.10.2 

func NewIRODSMessageReadDataObjectRequest(desc int, len int) *IRODSMessageReadDataObjectRequest

NewIRODSMessageReadDataObjectRequest creates a IRODSMessageReadDataObjectRequest message

func (*IRODSMessageReadDataObjectRequest) AddKeyVal added in v0.10.2 

func (msg *IRODSMessageReadDataObjectRequest) AddKeyVal(key common.KeyWord, val string)

AddKeyVal adds a key-value pair

func (*IRODSMessageReadDataObjectRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageReadDataObjectRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageReadDataObjectRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageReadDataObjectRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageReadDataObjectRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageReadDataObjectRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageReadDataObjectResponse added in v0.10.2 

type IRODSMessageReadDataObjectResponse struct {
	// empty structure
	Result int
	Data   []byte
}

IRODSMessageReadDataObjectResponse stores data object read response

func (*IRODSMessageReadDataObjectResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageReadDataObjectResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageReadDataObjectResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageReadDataObjectResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageRemoveCollectionRequest added in v0.10.2 

type IRODSMessageRemoveCollectionRequest struct {
	XMLName       xml.Name             `xml:"CollInpNew_PI"`
	Name          string               `xml:"collName"`
	Flags         int                  `xml:"flags"`
	OperationType int                  `xml:"oprType"`
	KeyVals       IRODSMessageSSKeyVal `xml:"KeyValPair_PI"`
}

IRODSMessageRemoveCollectionRequest stores collection deletion request

func NewIRODSMessageRemoveCollectionRequest added in v0.10.2 

func NewIRODSMessageRemoveCollectionRequest(name string, recurse bool, force bool) *IRODSMessageRemoveCollectionRequest

NewIRODSMessageRemoveCollectionRequest creates a IRODSMessageRemoveCollectionRequest message

func (*IRODSMessageRemoveCollectionRequest) AddKeyVal added in v0.10.2 

func (msg *IRODSMessageRemoveCollectionRequest) AddKeyVal(key common.KeyWord, val string)

AddKeyVal adds a key-value pair

func (*IRODSMessageRemoveCollectionRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageRemoveCollectionRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageRemoveCollectionRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageRemoveCollectionRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageRemoveCollectionRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageRemoveCollectionRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageRemoveCollectionResponse added in v0.10.2 

type IRODSMessageRemoveCollectionResponse struct {
	// empty structure
	Result int
}

IRODSMessageRemoveCollectionResponse stores collection deletion response

func (*IRODSMessageRemoveCollectionResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageRemoveCollectionResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageRemoveCollectionResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageRemoveCollectionResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageRemoveDataObjectRequest added in v0.10.2 

type IRODSMessageRemoveDataObjectRequest IRODSMessageDataObjectRequest

IRODSMessageRemoveDataObjectRequest stores data object deletion request

func NewIRODSMessageRemoveDataObjectRequest added in v0.10.2 

func NewIRODSMessageRemoveDataObjectRequest(path string, force bool) *IRODSMessageRemoveDataObjectRequest

NewIRODSMessageRemoveDataObjectRequest creates a IRODSMessageRemoveDataObjectRequest message

func (*IRODSMessageRemoveDataObjectRequest) AddKeyVal added in v0.10.2 

func (msg *IRODSMessageRemoveDataObjectRequest) AddKeyVal(key common.KeyWord, val string)

AddKeyVal adds a key-value pair

func (*IRODSMessageRemoveDataObjectRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageRemoveDataObjectRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageRemoveDataObjectRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageRemoveDataObjectRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageRemoveDataObjectRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageRemoveDataObjectRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageRemoveDataObjectResponse added in v0.10.2 

type IRODSMessageRemoveDataObjectResponse struct {
	// empty structure
	Result int
}

IRODSMessageRemoveDataObjectResponse stores data object deletion response

func (*IRODSMessageRemoveDataObjectResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageRemoveDataObjectResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageRemoveDataObjectResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageRemoveDataObjectResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageReplicateDataObjectRequest added in v0.10.2 

type IRODSMessageReplicateDataObjectRequest IRODSMessageDataObjectRequest

IRODSMessageReplicateDataObjectRequest stores data object replication request

func NewIRODSMessageReplicateDataObjectRequest added in v0.10.2 

func NewIRODSMessageReplicateDataObjectRequest(path string, resource string) *IRODSMessageReplicateDataObjectRequest

NewIRODSMessageReplicateDataObjectRequest creates a IRODSMessageReplicateDataObjectRequest message

func (*IRODSMessageReplicateDataObjectRequest) AddKeyVal added in v0.10.2 

func (msg *IRODSMessageReplicateDataObjectRequest) AddKeyVal(key common.KeyWord, val string)

AddKeyVal adds a key-value pair

func (*IRODSMessageReplicateDataObjectRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageReplicateDataObjectRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageReplicateDataObjectRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageReplicateDataObjectRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageReplicateDataObjectRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageReplicateDataObjectRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageReplicateDataObjectResponse added in v0.10.2 

type IRODSMessageReplicateDataObjectResponse struct {
	// empty structure
	Result int
}

IRODSMessageReplicateDataObjectResponse stores data object replication response

func (*IRODSMessageReplicateDataObjectResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageReplicateDataObjectResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageReplicateDataObjectResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageReplicateDataObjectResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageResourceServerAuth added in v0.14.0 

type IRODSMessageResourceServerAuth struct {
	Cookie int
}

IRODSMessageResourceServerAuth stores resource server authentication message

func NewIRODSMessageResourceServerAuth added in v0.14.0 

func NewIRODSMessageResourceServerAuth(redirectionInfo *types.IRODSRedirectionInfo) *IRODSMessageResourceServerAuth

NewIRODSMessageResourceServerAuth creates a IRODSMessageResourceServerAuth message

func (*IRODSMessageResourceServerAuth) GetBytes added in v0.14.0 

func (msg *IRODSMessageResourceServerAuth) GetBytes() ([]byte, error)

GetBytes returns byte array

type IRODSMessageResourceServerTransferEncryptionHeader added in v0.14.0 

type IRODSMessageResourceServerTransferEncryptionHeader struct {
	Length int
	IV     []byte
	// contains filtered or unexported fields
}

IRODSMessageResourceServerTransferEncryptionHeader stores resource server transfer encryption header message

func NewIRODSMessageResourceServerTransferEncryptionHeader added in v0.14.0 

func NewIRODSMessageResourceServerTransferEncryptionHeader(ivSize int) *IRODSMessageResourceServerTransferEncryptionHeader

NewIRODSMessageResourceServerTransferEncryptionHeader creates IRODSMessageResourceServerTransferEncryptionHeader

func (*IRODSMessageResourceServerTransferEncryptionHeader) FromBytes added in v0.14.0 

func (msg *IRODSMessageResourceServerTransferEncryptionHeader) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageResourceServerTransferEncryptionHeader) GetBytes added in v0.14.0 

func (msg *IRODSMessageResourceServerTransferEncryptionHeader) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageResourceServerTransferEncryptionHeader) SizeOf added in v0.14.0 

func (msg *IRODSMessageResourceServerTransferEncryptionHeader) SizeOf() int

SizeOf returns struct size in bytes

type IRODSMessageResourceServerTransferHeader added in v0.14.0 

type IRODSMessageResourceServerTransferHeader struct {
	OperationType int
	Flags         int
	Offset        int64
	Length        int64
}

IRODSMessageResourceServerTransferHeader stores resource server transfer header message

func (*IRODSMessageResourceServerTransferHeader) FromBytes added in v0.14.0 

func (msg *IRODSMessageResourceServerTransferHeader) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageResourceServerTransferHeader) SizeOf added in v0.14.0 

func (msg *IRODSMessageResourceServerTransferHeader) SizeOf() int

SizeOf returns struct size in bytes

type IRODSMessageSQLResult 

type IRODSMessageSQLResult struct {
	XMLName        xml.Name `xml:"SqlResult_PI"`
	AttributeIndex int      `xml:"attriInx"`
	ResultLen      int      `xml:"reslen"`
	Values         []string `xml:"value,omitempty"`
}

IRODSMessageSQLResult ..

type IRODSMessageSSKeyVal 

type IRODSMessageSSKeyVal struct {
	XMLName xml.Name                `xml:"KeyValPair_PI"`
	Length  int                     `xml:"ssLen"`
	Keys    []string                `xml:"keyWord,omitempty"`
	Values  []IRODSMessageRawString `xml:"svalue,omitempty"`
}

IRODSMessageSSKeyVal ..

func NewIRODSMessageSSKeyVal 

func NewIRODSMessageSSKeyVal() *IRODSMessageSSKeyVal

NewIRODSMessageSSKeyVal creates a new IRODSMessageSSKeyVal

func (*IRODSMessageSSKeyVal) Add 

func (kv *IRODSMessageSSKeyVal) Add(key string, val string)

Add adds a key-val pair

type IRODSMessageSSLSettings 

type IRODSMessageSSLSettings struct {
	EncryptionAlgorithm string
	EncryptionKeySize   uint32
	SaltSize            uint32
	HashRounds          uint32
}

IRODSMessageSSLSettings stores ssl settings

func NewIRODSMessageSSLSettings 

func NewIRODSMessageSSLSettings(algorithm string, keySize int, saltSize int, hashRounds int) *IRODSMessageSSLSettings

NewIRODSMessageSSLSettings creates a IRODSMessageSSLSettings message

func (*IRODSMessageSSLSettings) FromBytes added in v0.6.0 

func (msg *IRODSMessageSSLSettings) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageSSLSettings) FromMessage added in v0.6.0 

func (msg *IRODSMessageSSLSettings) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessageSSLSettings) GetBytes added in v0.6.0 

func (msg *IRODSMessageSSLSettings) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageSSLSettings) GetMessage 

func (msg *IRODSMessageSSLSettings) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageSSLSharedSecret 

type IRODSMessageSSLSharedSecret struct {
	SharedSecret []byte
}

IRODSMessageSSLSharedSecret stores shared secret data

func NewIRODSMessageSSLSharedSecret 

func NewIRODSMessageSSLSharedSecret(sharedSecret []byte) *IRODSMessageSSLSharedSecret

NewIRODSMessageSSLSharedSecret creates a IRODSMessageSSLSharedSecret message

func (*IRODSMessageSSLSharedSecret) FromMessage added in v0.6.0 

func (msg *IRODSMessageSSLSharedSecret) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessageSSLSharedSecret) GetMessage 

func (msg *IRODSMessageSSLSharedSecret) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageSeekDataObjectRequest added in v0.10.2 

type IRODSMessageSeekDataObjectRequest IRODSMessageOpenedDataObjectRequest

IRODSMessageSeekDataObjectRequest stores data object seek request

func NewIRODSMessageSeekDataObjectRequest added in v0.10.2 

func NewIRODSMessageSeekDataObjectRequest(desc int, offset int64, whence types.Whence) *IRODSMessageSeekDataObjectRequest

NewIRODSMessageSeekDataObjectRequest creates a IRODSMessageSeekDataObjectRequest message

func (*IRODSMessageSeekDataObjectRequest) AddKeyVal added in v0.10.2 

func (msg *IRODSMessageSeekDataObjectRequest) AddKeyVal(key common.KeyWord, val string)

AddKeyVal adds a key-value pair

func (*IRODSMessageSeekDataObjectRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageSeekDataObjectRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageSeekDataObjectRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageSeekDataObjectRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageSeekDataObjectRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageSeekDataObjectRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageSeekDataObjectResponse added in v0.10.2 

type IRODSMessageSeekDataObjectResponse struct {
	XMLName xml.Name `xml:"fileLseekOut_PI"`
	Offset  int64    `xml:"offset"`
}

IRODSMessageSeekDataObjectResponse stores data object seek response

func (*IRODSMessageSeekDataObjectResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageSeekDataObjectResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageSeekDataObjectResponse) FromBytes added in v0.10.2 

func (msg *IRODSMessageSeekDataObjectResponse) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageSeekDataObjectResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageSeekDataObjectResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageSerializationInterface 

type IRODSMessageSerializationInterface interface {
	GetBytes() ([]byte, error)
	FromBytes(bodyBytes []byte, bsBytes []byte) error
}

IRODSMessageSerializationInterface is an interface for serializaing/deserializing of message

type IRODSMessageSpecialCollection added in v0.10.2 

type IRODSMessageSpecialCollection struct {
	XMLName           xml.Name `xml:"SpecColl_PI"`
	CollectionClass   int      `xml:"collClass"`
	Type              int      `xml:"type"`
	Collection        string   `xml:"collection"`
	ObjectPath        string   `xml:"objPath"`
	Resource          string   `xml:"resource"`
	ResourceHierarchy string   `xml:"rescHier"`
	PhysicalPath      string   `xml:"phyPath"`
	CacheDirectory    string   `xml:"cacheDir"`
	CacheDirty        int      `xml:"cacheDirty"`
	ReplicationNumber int      `xml:"replNum"`
}

type IRODSMessageStartupPack 

type IRODSMessageStartupPack struct {
	XMLName         xml.Name `xml:"StartupPack_PI"`
	Protocol        int      `xml:"irodsProt"`
	ReconnectFlag   int      `xml:"reconnFlag"`
	ConnectionCount int      `xml:"connectCnt"`
	ProxyUser       string   `xml:"proxyUser"`
	ProxyRcatZone   string   `xml:"proxyRcatZone"`
	ClientUser      string   `xml:"clientUser"`
	ClientRcatZone  string   `xml:"clientRcatZone"`
	ReleaseVersion  string   `xml:"relVersion"`
	APIVersion      string   `xml:"apiVersion"`
	Option          string   `xml:"option"`
}

IRODSMessageStartupPack stores startup message

func NewIRODSMessageStartupPack 

func NewIRODSMessageStartupPack(account *types.IRODSAccount, option string, requireNegotiation bool) *IRODSMessageStartupPack

NewIRODSMessageStartupPack creates a IRODSMessageStartupPack message

func (*IRODSMessageStartupPack) FromBytes 

func (msg *IRODSMessageStartupPack) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageStartupPack) FromMessage added in v0.4.5 

func (msg *IRODSMessageStartupPack) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessageStartupPack) GetBytes 

func (msg *IRODSMessageStartupPack) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageStartupPack) GetMessage 

func (msg *IRODSMessageStartupPack) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageTicketAdminRequest added in v0.5.1 

type IRODSMessageTicketAdminRequest struct {
	XMLName xml.Name             `xml:"ticketAdminInp_PI"`
	Action  string               `xml:"arg1"` // session, create, or mod
	Ticket  string               `xml:"arg2"` // ticket name
	Arg3    string               `xml:"arg3"` // ticket type
	Arg4    string               `xml:"arg4"` // path
	Arg5    string               `xml:"arg5"` // ticket name again
	Arg6    string               `xml:"arg6"`
	KeyVals IRODSMessageSSKeyVal `xml:"KeyValPair_PI"`
}

IRODSMessageTicketAdminRequest stores ticket admin request

func NewIRODSMessageTicketAdminRequest added in v0.5.1 

func NewIRODSMessageTicketAdminRequest(action string, ticket string, args ...string) *IRODSMessageTicketAdminRequest

NewIRODSMessageTicketAdminRequest creates a new IRODSMessageTicketAdminRequest

func (*IRODSMessageTicketAdminRequest) AddKeyVal added in v0.12.14 

func (msg *IRODSMessageTicketAdminRequest) AddKeyVal(key common.KeyWord, val string)

AddKeyVal adds a key-value pair

func (*IRODSMessageTicketAdminRequest) FromBytes added in v0.5.1 

func (msg *IRODSMessageTicketAdminRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageTicketAdminRequest) GetBytes added in v0.5.1 

func (msg *IRODSMessageTicketAdminRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageTicketAdminRequest) GetMessage added in v0.5.1 

func (msg *IRODSMessageTicketAdminRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageTicketAdminResponse added in v0.5.1 

type IRODSMessageTicketAdminResponse struct {
	// empty structure
	Result int
}

IRODSMessageTicketAdminResponse stores ticket admin response

func (*IRODSMessageTicketAdminResponse) CheckError added in v0.5.1 

func (msg *IRODSMessageTicketAdminResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageTicketAdminResponse) FromMessage added in v0.5.1 

func (msg *IRODSMessageTicketAdminResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageTrimDataObjectRequest added in v0.10.2 

type IRODSMessageTrimDataObjectRequest IRODSMessageDataObjectRequest

IRODSMessageTrimDataObjectRequest stores data object replication request

func NewIRODSMessageTrimDataObjectRequest added in v0.10.2 

func NewIRODSMessageTrimDataObjectRequest(path string, resource string, minCopies int, minAgeMinutes int) *IRODSMessageTrimDataObjectRequest

NewIRODSMessageTrimDataObjectRequest creates a IRODSMessageTrimDataObjectRequest message

func (*IRODSMessageTrimDataObjectRequest) AddKeyVal added in v0.10.2 

func (msg *IRODSMessageTrimDataObjectRequest) AddKeyVal(key common.KeyWord, val string)

AddKeyVal adds a key-value pair

func (*IRODSMessageTrimDataObjectRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageTrimDataObjectRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageTrimDataObjectRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageTrimDataObjectRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageTrimDataObjectRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageTrimDataObjectRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageTrimDataObjectResponse added in v0.10.2 

type IRODSMessageTrimDataObjectResponse struct {
	// empty structure
	Result int
}

IRODSMessageTrimDataObjectResponse stores data object trim response

func (*IRODSMessageTrimDataObjectResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageTrimDataObjectResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageTrimDataObjectResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageTrimDataObjectResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageTruncateDataObjectRequest added in v0.10.2 

type IRODSMessageTruncateDataObjectRequest IRODSMessageDataObjectRequest

IRODSMessageTruncateDataObjectRequest stores data object truncation request

func NewIRODSMessageTruncateDataObjectRequest added in v0.10.2 

func NewIRODSMessageTruncateDataObjectRequest(path string, size int64) *IRODSMessageTruncateDataObjectRequest

NewIRODSMessageTruncateDataObjectRequest creates a IRODSMessageTruncateDataObjectRequest message

func (*IRODSMessageTruncateDataObjectRequest) AddKeyVal added in v0.10.2 

func (msg *IRODSMessageTruncateDataObjectRequest) AddKeyVal(key common.KeyWord, val string)

AddKeyVal adds a key-value pair

func (*IRODSMessageTruncateDataObjectRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageTruncateDataObjectRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageTruncateDataObjectRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageTruncateDataObjectRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageTruncateDataObjectRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageTruncateDataObjectRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageTruncateDataObjectResponse added in v0.10.2 

type IRODSMessageTruncateDataObjectResponse struct {
	// empty structure
	Result int
}

IRODSMessageTruncateDataObjectResponse stores data object truncation response

func (*IRODSMessageTruncateDataObjectResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageTruncateDataObjectResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageTruncateDataObjectResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageTruncateDataObjectResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageUnlockDataObjectRequest added in v0.12.8 

type IRODSMessageUnlockDataObjectRequest IRODSMessageDataObjectRequest

IRODSMessageUnlockDataObjectRequest stores data object unlock request

func NewIRODSMessageUnlockDataObjectRequest added in v0.12.8 

func NewIRODSMessageUnlockDataObjectRequest(path string, lockDesc int) *IRODSMessageUnlockDataObjectRequest

NewIRODSMessageUnlockDataObjectRequest creates a IRODSMessageUnlockDataObjectRequest message

func (*IRODSMessageUnlockDataObjectRequest) AddKeyVal added in v0.12.8 

func (msg *IRODSMessageUnlockDataObjectRequest) AddKeyVal(key common.KeyWord, val string)

AddKeyVal adds a key-value pair

func (*IRODSMessageUnlockDataObjectRequest) FromBytes added in v0.12.8 

func (msg *IRODSMessageUnlockDataObjectRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageUnlockDataObjectRequest) GetBytes added in v0.12.8 

func (msg *IRODSMessageUnlockDataObjectRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageUnlockDataObjectRequest) GetMessage added in v0.12.8 

func (msg *IRODSMessageUnlockDataObjectRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageUnlockDataObjectResponse added in v0.12.8 

type IRODSMessageUnlockDataObjectResponse struct {
	// empty structure
	Result int
}

IRODSMessageUnlockDataObjectResponse stores data object unlock response

func (*IRODSMessageUnlockDataObjectResponse) CheckError added in v0.12.8 

func (msg *IRODSMessageUnlockDataObjectResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageUnlockDataObjectResponse) FromMessage added in v0.12.8 

func (msg *IRODSMessageUnlockDataObjectResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageUserAdminRequest added in v0.4.4 

type IRODSMessageUserAdminRequest struct {
	XMLName xml.Name `xml:"userAdminInp_PI"`
	Action  string   `xml:"arg0"` // mkuser, mkgroup, modify
	Arg1    string   `xml:"arg1"`
	Arg2    string   `xml:"arg2"`
	Arg3    string   `xml:"arg3"`
	Arg4    string   `xml:"arg4"`
	Arg5    string   `xml:"arg5"`
	Arg6    string   `xml:"arg6"`
	Arg7    string   `xml:"arg7"`
	Arg8    string   `xml:"arg8"` // unused
	Arg9    string   `xml:"arg9"` // unused
}

IRODSMessageUserAdminRequest stores alter metadata request

func NewIRODSMessageUserAdminRequest added in v0.4.4 

func NewIRODSMessageUserAdminRequest(action string, args ...string) *IRODSMessageUserAdminRequest

NewIRODSMessageUserAdminRequest creates a new IRODSMessageUserAdminRequest

func (*IRODSMessageUserAdminRequest) FromBytes added in v0.4.4 

func (msg *IRODSMessageUserAdminRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageUserAdminRequest) GetBytes added in v0.4.4 

func (msg *IRODSMessageUserAdminRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageUserAdminRequest) GetMessage added in v0.4.4 

func (msg *IRODSMessageUserAdminRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageUserAdminResponse added in v0.4.4 

type IRODSMessageUserAdminResponse struct {
	// empty structure
	Result int
}

IRODSMessageUserAdminResponse stores alter metadata response

func (*IRODSMessageUserAdminResponse) CheckError added in v0.4.4 

func (msg *IRODSMessageUserAdminResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageUserAdminResponse) FromMessage added in v0.4.4 

func (msg *IRODSMessageUserAdminResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type IRODSMessageVersion 

type IRODSMessageVersion struct {
	XMLName        xml.Name `xml:"Version_PI"`
	Status         int      `xml:"status"`
	ReleaseVersion string   `xml:"relVersion"`
	APIVersion     string   `xml:"apiVersion"`
	ReconnectPort  int      `xml:"reconnPort"`
	ReconnectAddr  string   `xml:"reconnAddr"`
	Cookie         int      `xml:"cookie"`
}

IRODSMessageVersion stores version message

func (*IRODSMessageVersion) CheckError 

func (msg *IRODSMessageVersion) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageVersion) FromBytes 

func (msg *IRODSMessageVersion) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageVersion) FromMessage 

func (msg *IRODSMessageVersion) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

func (*IRODSMessageVersion) GetBytes 

func (msg *IRODSMessageVersion) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageVersion) GetMessage added in v0.6.0 

func (msg *IRODSMessageVersion) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

func (*IRODSMessageVersion) GetVersion 

func (msg *IRODSMessageVersion) GetVersion() *types.IRODSVersion

GetVersion creates IRODSVersion

type IRODSMessageWriteDataObjectRequest added in v0.10.2 

type IRODSMessageWriteDataObjectRequest struct {
	IRODSMessageOpenedDataObjectRequest
	Data []byte `xml:"-"`
}

IRODSMessageWriteDataObjectRequest stores data object read request type IRODSMessageWriteDataObjectRequest IRODSMessageOpenedDataObjectRequest

func NewIRODSMessageWriteDataObjectRequest added in v0.10.2 

func NewIRODSMessageWriteDataObjectRequest(desc int, data []byte) *IRODSMessageWriteDataObjectRequest

NewIRODSMessageWriteDataObjectRequest creates a IRODSMessageWriteDataObjectRequest message

func (*IRODSMessageWriteDataObjectRequest) AddKeyVal added in v0.10.2 

func (msg *IRODSMessageWriteDataObjectRequest) AddKeyVal(key common.KeyWord, val string)

AddKeyVal adds a key-value pair

func (*IRODSMessageWriteDataObjectRequest) FromBytes added in v0.10.2 

func (msg *IRODSMessageWriteDataObjectRequest) FromBytes(bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageWriteDataObjectRequest) GetBytes added in v0.10.2 

func (msg *IRODSMessageWriteDataObjectRequest) GetBytes() ([]byte, error)

GetBytes returns byte array

func (*IRODSMessageWriteDataObjectRequest) GetMessage added in v0.10.2 

func (msg *IRODSMessageWriteDataObjectRequest) GetMessage() (*IRODSMessage, error)

GetMessage builds a message

type IRODSMessageWriteDataObjectResponse added in v0.10.2 

type IRODSMessageWriteDataObjectResponse struct {
	// empty structure
	Result int
}

IRODSMessageWriteDataObjectResponse stores data object write response

func (*IRODSMessageWriteDataObjectResponse) CheckError added in v0.10.2 

func (msg *IRODSMessageWriteDataObjectResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageWriteDataObjectResponse) FromMessage added in v0.10.2 

func (msg *IRODSMessageWriteDataObjectResponse) FromMessage(msgIn *IRODSMessage) error

FromMessage returns struct from IRODSMessage

type MessageType 

type MessageType string

MessageType is a message type 

const (
	// RODS_MESSAGE_API_REQ_TYPE is a type for api request
	RODS_MESSAGE_API_REQ_TYPE MessageType = "RODS_API_REQ"
	// RODS_MESSAGE_API_REPLY_TYPE is a type for api response
	RODS_MESSAGE_API_REPLY_TYPE MessageType = "RODS_API_REPLY"
)
const (
	// RODS_MESSAGE_DISCONNECT_TYPE is a message type for disconnecting
	RODS_MESSAGE_DISCONNECT_TYPE MessageType = "RODS_DISCONNECT"
)
const (
	// RODS_MESSAGE_SSL_SHARED_SECRET_TYPE is a message type for shared secret used in SSL connection establishment
	RODS_MESSAGE_SSL_SHARED_SECRET_TYPE MessageType = "SHARED_SECRET"
)
const (
	// RODS_MESSAGE_VERSION_TYPE is a message type for version
	RODS_MESSAGE_VERSION_TYPE MessageType = "RODS_VERSION"
)

type STRI_PI added in v0.12.6 

type STRI_PI struct {
}

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.