message

package
v0.5.6 Latest Latest
Warning

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

Go to latest
Published: Oct 6, 2021 License: BSD-3-Clause Imports: 9 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 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 IRODSMessageAuthChallenge

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

IRODSMessageAuthChallenge stores auth challenge

func (*IRODSMessageAuthChallenge) FromBytes

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

FromBytes returns struct from bytes

func (*IRODSMessageAuthChallenge) FromMessage

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

FromMessage returns struct from IRODSMessage

func (*IRODSMessageAuthChallenge) GetBytes

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

GetBytes returns byte array

type IRODSMessageAuthPluginOut

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

IRODSMessageAuthPluginOut stores auth plugin info

func NewIRODSMessageAuthPluginOut

func NewIRODSMessageAuthPluginOut(result string) *IRODSMessageAuthPluginOut

NewIRODSMessageAuthPluginOut creates a IRODSMessageAuthPluginOut message

func (*IRODSMessageAuthPluginOut) FromXML

func (out *IRODSMessageAuthPluginOut) FromXML(bytes []byte) error

FromXML returns struct from XML

func (*IRODSMessageAuthPluginOut) ToXML

func (out *IRODSMessageAuthPluginOut) ToXML() ([]byte, error)

ToXML returns XML byte array

type IRODSMessageAuthRequest

type IRODSMessageAuthRequest struct {
}

IRODSMessageAuthRequest stores authentication request

func NewIRODSMessageAuthRequest

func NewIRODSMessageAuthRequest() *IRODSMessageAuthRequest

NewIRODSMessageAuthRequest creates a IRODSMessageAuthRequest message

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) 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

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, bytes []byte) error

FromBytes returns struct from bytes

func (*IRODSMessageBody) GetBytes

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

GetBytes returns byte array

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(status int, 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 IRODSMessageCloseobjRequest

type IRODSMessageCloseobjRequest IRODSMessageOpenedDataObjectRequest

IRODSMessageCloseobjRequest stores data object close request

func NewIRODSMessageCloseobjRequest

func NewIRODSMessageCloseobjRequest(desc int) *IRODSMessageCloseobjRequest

NewIRODSMessageCloseobjRequest creates a IRODSMessageCloseobjRequest message

func (*IRODSMessageCloseobjRequest) AddKeyVal

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

AddKeyVal adds a key-value pair

func (*IRODSMessageCloseobjRequest) FromBytes

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

FromBytes returns struct from bytes

func (*IRODSMessageCloseobjRequest) GetBytes

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

GetBytes returns byte array

func (*IRODSMessageCloseobjRequest) GetMessage

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

GetMessage builds a message

type IRODSMessageCloseobjResponse

type IRODSMessageCloseobjResponse struct {
	// empty structure
	Result int
}

IRODSMessageCloseobjResponse stores data object close response

func (*IRODSMessageCloseobjResponse) CheckError

func (msg *IRODSMessageCloseobjResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageCloseobjResponse) FromMessage

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

FromMessage returns struct from IRODSMessage

type IRODSMessageClosereplicaRequest added in v0.5.2

type IRODSMessageClosereplicaRequest 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"`
}

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

func NewIRODSMessageClosereplicaRequest added in v0.5.2

func NewIRODSMessageClosereplicaRequest(desc int, sendNotification bool, updateSize bool, updateStatus bool, computeChecksum bool) *IRODSMessageClosereplicaRequest

NewIRODSMessageClosereplicaRequest creates a IRODSMessageClosereplicaRequest message

func (*IRODSMessageClosereplicaRequest) FromBytes added in v0.5.2

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

FromBytes returns struct from bytes

func (*IRODSMessageClosereplicaRequest) GetBytes added in v0.5.2

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

GetBytes returns byte array

func (*IRODSMessageClosereplicaRequest) GetMessage added in v0.5.2

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

GetMessage builds a message

type IRODSMessageClosereplicaResponse added in v0.5.2

type IRODSMessageClosereplicaResponse struct {
	// empty structure
	Result int
}

IRODSMessageClosereplicaResponse stores data object replica close response

func (*IRODSMessageClosereplicaResponse) CheckError added in v0.5.2

func (msg *IRODSMessageClosereplicaResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageClosereplicaResponse) FromMessage added in v0.5.2

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

FromMessage returns struct from IRODSMessage

type IRODSMessageCpobjRequest

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

IRODSMessageCpobjRequest stores data object copy request

func NewIRODSMessageCpobjRequest

func NewIRODSMessageCpobjRequest(srcPath string, destPath string) *IRODSMessageCpobjRequest

NewIRODSMessageCpobjRequest creates a IRODSMessageCpobjRequest message

func (*IRODSMessageCpobjRequest) FromBytes

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

FromBytes returns struct from bytes

func (*IRODSMessageCpobjRequest) GetBytes

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

GetBytes returns byte array

func (*IRODSMessageCpobjRequest) GetMessage

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

GetMessage builds a message

type IRODSMessageCpobjResponse

type IRODSMessageCpobjResponse struct {
	// empty structure
	Result int
}

IRODSMessageCpobjResponse stores data object copy response

func (*IRODSMessageCpobjResponse) CheckError

func (msg *IRODSMessageCpobjResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageCpobjResponse) FromMessage

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

FromMessage returns struct from IRODSMessage

type IRODSMessageCreateobjRequest

type IRODSMessageCreateobjRequest IRODSMessageDataObjectRequest

IRODSMessageCreateobjRequest stores data object creation request

func NewIRODSMessageCreateobjRequest

func NewIRODSMessageCreateobjRequest(path string, resource string, force bool) *IRODSMessageCreateobjRequest

NewIRODSMessageCreateobjRequest creates a IRODSMessageCreateobjRequest message

func (*IRODSMessageCreateobjRequest) AddKeyVal

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

AddKeyVal adds a key-value pair

func (*IRODSMessageCreateobjRequest) FromBytes

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

FromBytes returns struct from bytes

func (*IRODSMessageCreateobjRequest) GetBytes

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

GetBytes returns byte array

func (*IRODSMessageCreateobjRequest) GetMessage

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

GetMessage builds a message

type IRODSMessageCreateobjResponse

type IRODSMessageCreateobjResponse struct {
	// empty structure
	FileDescriptor int
}

IRODSMessageCreateobjResponse stores data object creation response

func (*IRODSMessageCreateobjResponse) CheckError

func (msg *IRODSMessageCreateobjResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageCreateobjResponse) FromMessage

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

FromMessage returns struct from IRODSMessage

func (*IRODSMessageCreateobjResponse) GetFileDescriptor

func (msg *IRODSMessageCreateobjResponse) GetFileDescriptor() int

GetFileDescriptor returns file descriptor

type IRODSMessageData

type IRODSMessageData struct {
	Type MessageType
	Data []byte
}

IRODSMessageData stores byte data

func NewIRODSMessageData

func NewIRODSMessageData(msgType MessageType, data []byte) *IRODSMessageData

NewIRODSMessageData creates a IRODSMessageData message

func (*IRODSMessageData) GetMessageBody

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

GetMessageBody builds a message body

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"`
	KeyVals       IRODSMessageSSKeyVal `xml:"KeyValPair_PI"`
}

IRODSMessageDataObjectRequest ...

type IRODSMessageDescriptorInfoRequest added in v0.5.2

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

IRODSMessageDescriptorInfoRequest stores data object descriptor info. request Uses JSON, not XML

func NewIRODSMessageDescriptorInfoRequest added in v0.5.2

func NewIRODSMessageDescriptorInfoRequest(desc int) *IRODSMessageDescriptorInfoRequest

NewIRODSMessageDescriptorInfoRequest creates a IRODSMessageDescriptorInfoRequest message

func (*IRODSMessageDescriptorInfoRequest) FromBytes added in v0.5.2

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

FromBytes returns struct from bytes

func (*IRODSMessageDescriptorInfoRequest) GetBytes added in v0.5.2

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

GetBytes returns byte array

func (*IRODSMessageDescriptorInfoRequest) GetMessage added in v0.5.2

GetMessage builds a message

type IRODSMessageDescriptorInfoResponse added in v0.5.2

type IRODSMessageDescriptorInfoResponse struct {
	L3DescriptorIndex       int                    `json:"l3descInx"`
	InUseFlag               int                    `json:"InuseFlag"`
	OperationType           int                    `json:"oprType"`
	OpenType                int                    `json:"openType"`
	OperationStatus         int                    `json:"oprStatus"`
	ReplicationFlag         int                    `json:"dataObjInpReplFlag"`
	DataObjectInput         map[string]interface{} `json:"dataObjInp"`
	DataObjectInfo          map[string]interface{} `json:"dataObjInfo"`
	OtherDataObjectInfo     map[string]interface{} `json:"otherDataObjInfo"`
	CopiesNeeded            int                    `json:"copiesNeeded"`
	BytesWritten            int64                  `json:"bytesWritten"`
	DataSize                int64                  `json:"dataSize"`
	ReplicaStatus           int                    `json:"replStatus"`
	ChecksumFlag            int                    `json:"chksumFlag"`
	SourceL1DescriptorIndex int                    `json:"srcL1descInx"`
	Checksum                string                 `json:"chksum"`
	RemoteL1DescriptorIndex int                    `json:"remoteL1descInx"`
	StageFlag               int                    `json:"stageFlag"`
	PurgeCacheFlag          int                    `json:"purgeCacheFlag"`
	LockFileDescriptor      int                    `json:"lockFd"`
	PluginData              map[string]interface{} `json:"pluginData"`
	ReplicaDataObjectInfo   map[string]interface{} `json:"replDataObjInfo"`
	RemoteZoneHost          map[string]interface{} `json:"remoteZoneHost"`
	InPDMO                  string                 `json:"in_pdmo"`
	ReplicaToken            string                 `json:"replica_token"`
	ResourceHierarchy       string                 `json:"resource_hierarchy"`

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

IRODSMessageDescriptorInfoResponse stores data object descriptor info. response

func (*IRODSMessageDescriptorInfoResponse) CheckError added in v0.5.2

func (msg *IRODSMessageDescriptorInfoResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageDescriptorInfoResponse) FromBytes added in v0.5.2

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

FromBytes returns struct from bytes

func (*IRODSMessageDescriptorInfoResponse) FromMessage added in v0.5.2

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

FromMessage returns struct from IRODSMessage

type IRODSMessageDisconnect

type IRODSMessageDisconnect struct {
}

IRODSMessageDisconnect stores disconnect request

func NewIRODSMessageDisconnect

func NewIRODSMessageDisconnect() *IRODSMessageDisconnect

NewIRODSMessageDisconnect creates a IRODSMessageAuthRequest message

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

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 IRODSMessageFileStatRequest added in v0.4.0

type IRODSMessageFileStatRequest 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"`
}

IRODSMessageFileStatRequest stores file stat request

func NewIRODSMessageFileStatRequest added in v0.4.0

func NewIRODSMessageFileStatRequest(resource *types.IRODSResource, obj *types.IRODSDataObject, replica *types.IRODSReplica) (*IRODSMessageFileStatRequest, error)

NewIRODSMessageFileStatRequest creates a IRODSMessageFileStatRequest message

func (*IRODSMessageFileStatRequest) FromBytes added in v0.4.0

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

FromBytes returns struct from bytes

func (*IRODSMessageFileStatRequest) GetBytes added in v0.4.0

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

GetBytes returns byte array

func (*IRODSMessageFileStatRequest) GetMessage added in v0.4.0

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

GetMessage builds a message

type IRODSMessageFileStatResponse added in v0.4.0

type IRODSMessageFileStatResponse 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:"-"`
}

IRODSMessageFileStatResponse stores data object read response

func (*IRODSMessageFileStatResponse) CheckError added in v0.5.1

func (msg *IRODSMessageFileStatResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageFileStatResponse) FromBytes added in v0.4.0

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

FromBytes returns struct from bytes

func (*IRODSMessageFileStatResponse) FromMessage added in v0.4.0

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

FromMessage returns struct from IRODSMessage

func (*IRODSMessageFileStatResponse) GetBytes added in v0.4.0

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

GetBytes returns byte array

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 IRODSMessageMkcolRequest

type IRODSMessageMkcolRequest 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"`
}

IRODSMessageMkcolRequest stores collection creation request

func NewIRODSMessageMkcolRequest

func NewIRODSMessageMkcolRequest(name string, recurse bool) *IRODSMessageMkcolRequest

NewIRODSMessageMkcolRequest creates a IRODSMessageMkcolRequest message

func (*IRODSMessageMkcolRequest) AddKeyVal

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

AddKeyVal adds a key-value pair

func (*IRODSMessageMkcolRequest) FromBytes

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

FromBytes returns struct from bytes

func (*IRODSMessageMkcolRequest) GetBytes

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

GetBytes returns byte array

func (*IRODSMessageMkcolRequest) GetMessage

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

GetMessage builds a message

type IRODSMessageMkcolResponse

type IRODSMessageMkcolResponse struct {
	// empty structure
	Result int
}

IRODSMessageMkcolResponse stores collection creation response

func (*IRODSMessageMkcolResponse) CheckError

func (msg *IRODSMessageMkcolResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageMkcolResponse) FromMessage

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

FromMessage returns struct from IRODSMessage

type IRODSMessageModAccessRequest added in v0.4.5

type IRODSMessageModAccessRequest 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"`
}

IRODSMessageModAccessRequest stores alter access control request

func NewIRODSMessageModAccessRequest added in v0.4.5

func NewIRODSMessageModAccessRequest(accessLevel, user, zone, path string, recursive, asAdmin bool) *IRODSMessageModAccessRequest

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

func (*IRODSMessageModAccessRequest) FromBytes added in v0.4.5

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

FromBytes returns struct from bytes

func (*IRODSMessageModAccessRequest) GetBytes added in v0.4.5

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

GetBytes returns byte array

func (*IRODSMessageModAccessRequest) GetMessage added in v0.4.5

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

GetMessage builds a message

type IRODSMessageModAccessResponse added in v0.4.5

type IRODSMessageModAccessResponse struct {
	// empty structure
	Result int
}

IRODSMessageModAccessResponse stores alter metadata response

func (*IRODSMessageModAccessResponse) CheckError added in v0.4.5

func (msg *IRODSMessageModAccessResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageModAccessResponse) FromMessage added in v0.4.5

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

FromMessage returns struct from IRODSMessage

type IRODSMessageModColRequest added in v0.4.4

type IRODSMessageModColRequest IRODSMessageMkcolRequest

IRODSMessageModColRequest stores mod coll request

func NewIRODSMessageModColRequest added in v0.4.4

func NewIRODSMessageModColRequest(name string) *IRODSMessageModColRequest

NewIRODSMessageModColRequest creates a IRODSMessageModcolRequest message

func (*IRODSMessageModColRequest) AddKeyVal added in v0.4.4

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

AddKeyVal adds a key-value pair

func (*IRODSMessageModColRequest) FromBytes added in v0.4.4

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

FromBytes returns struct from bytes

func (*IRODSMessageModColRequest) GetBytes added in v0.4.4

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

GetBytes returns byte array

func (*IRODSMessageModColRequest) GetMessage added in v0.4.4

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

GetMessage builds a message

type IRODSMessageModColResponse added in v0.4.4

type IRODSMessageModColResponse struct {
	// empty structure
	Result int
}

IRODSMessageModColResponse stores alter metadata response

func (*IRODSMessageModColResponse) CheckError added in v0.4.4

func (msg *IRODSMessageModColResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageModColResponse) FromMessage added in v0.4.4

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

FromMessage returns struct from IRODSMessage

type IRODSMessageModMetaRequest added in v0.2.0

type IRODSMessageModMetaRequest 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
}

IRODSMessageModMetaRequest stores alter metadata request

func NewIRODSMessageAddMetadataRequest added in v0.2.0

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

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) *IRODSMessageModMetaRequest

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) *IRODSMessageModMetaRequest

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) *IRODSMessageModMetaRequest

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) *IRODSMessageModMetaRequest

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) *IRODSMessageModMetaRequest

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 (*IRODSMessageModMetaRequest) FromBytes added in v0.2.0

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

FromBytes returns struct from bytes

func (*IRODSMessageModMetaRequest) GetBytes added in v0.2.0

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

GetBytes returns byte array

func (*IRODSMessageModMetaRequest) GetMessage added in v0.2.0

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

GetMessage builds a message

type IRODSMessageModMetaResponse added in v0.2.0

type IRODSMessageModMetaResponse struct {
	// empty structure
	Result int
}

IRODSMessageModMetaResponse stores alter metadata response

func (*IRODSMessageModMetaResponse) CheckError added in v0.2.0

func (msg *IRODSMessageModMetaResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageModMetaResponse) FromMessage added in v0.2.0

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

FromMessage returns struct from IRODSMessage

type IRODSMessageMvcolRequest

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

IRODSMessageMvcolRequest stores collection move request

func NewIRODSMessageMvcolRequest

func NewIRODSMessageMvcolRequest(srcPath string, destPath string) *IRODSMessageMvcolRequest

NewIRODSMessageMvcolRequest creates a IRODSMessageMvcolRequest message

func (*IRODSMessageMvcolRequest) FromBytes

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

FromBytes returns struct from bytes

func (*IRODSMessageMvcolRequest) GetBytes

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

GetBytes returns byte array

func (*IRODSMessageMvcolRequest) GetMessage

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

GetMessage builds a message

type IRODSMessageMvcolResponse

type IRODSMessageMvcolResponse struct {
	// empty structure
	Result int
}

IRODSMessageMvcolResponse stores collection move response

func (*IRODSMessageMvcolResponse) CheckError

func (msg *IRODSMessageMvcolResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageMvcolResponse) FromMessage

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

FromMessage returns struct from IRODSMessage

type IRODSMessageMvobjRequest

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

IRODSMessageMvobjRequest stores data object move request

func NewIRODSMessageMvobjRequest

func NewIRODSMessageMvobjRequest(srcPath string, destPath string) *IRODSMessageMvobjRequest

NewIRODSMessageMvobjRequest creates a IRODSMessageMvobjRequest message

func (*IRODSMessageMvobjRequest) FromBytes

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

FromBytes returns struct from bytes

func (*IRODSMessageMvobjRequest) GetBytes

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

GetBytes returns byte array

func (*IRODSMessageMvobjRequest) GetMessage

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

GetMessage builds a message

type IRODSMessageMvobjResponse

type IRODSMessageMvobjResponse struct {
	// empty structure
	Result int
}

IRODSMessageMvobjResponse stores data object move response

func (*IRODSMessageMvobjResponse) CheckError

func (msg *IRODSMessageMvobjResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageMvobjResponse) FromMessage

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

FromMessage returns struct from IRODSMessage

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 IRODSMessageOpenobjRequest

type IRODSMessageOpenobjRequest IRODSMessageDataObjectRequest

IRODSMessageOpenobjRequest stores data object open request

func NewIRODSMessageOpenobjRequest

func NewIRODSMessageOpenobjRequest(path string, resource string, mode types.FileOpenMode) *IRODSMessageOpenobjRequest

NewIRODSMessageOpenobjRequest creates a IRODSMessageOpenobjRequest message

func NewIRODSMessageOpenobjRequestWithOperation

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

NewIRODSMessageOpenobjRequestWithOperation ...

func (*IRODSMessageOpenobjRequest) AddKeyVal

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

AddKeyVal adds a key-value pair

func (*IRODSMessageOpenobjRequest) FromBytes

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

FromBytes returns struct from bytes

func (*IRODSMessageOpenobjRequest) GetBytes

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

GetBytes returns byte array

func (*IRODSMessageOpenobjRequest) GetMessage

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

GetMessage builds a message

type IRODSMessageOpenobjResponse

type IRODSMessageOpenobjResponse struct {
	// empty structure
	FileDescriptor int
}

IRODSMessageOpenobjResponse stores data object open response

func (*IRODSMessageOpenobjResponse) CheckError

func (msg *IRODSMessageOpenobjResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageOpenobjResponse) FromMessage

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

FromMessage returns struct from IRODSMessage

func (*IRODSMessageOpenobjResponse) GetFileDescriptor

func (msg *IRODSMessageOpenobjResponse) GetFileDescriptor() int

GetFileDescriptor returns file descriptor

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 IRODSMessagePluginAuthMessage

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

IRODSMessagePluginAuthMessage stores auth plugin message

func NewIRODSMessagePluginAuthMessage

func NewIRODSMessagePluginAuthMessage(authScheme string, context string) *IRODSMessagePluginAuthMessage

NewIRODSMessagePluginAuthMessage creates a IRODSMessagePluginAuthMessage message

func (*IRODSMessagePluginAuthMessage) FromXML

func (message *IRODSMessagePluginAuthMessage) FromXML(bytes []byte) error

FromXML returns struct from XML

func (*IRODSMessagePluginAuthMessage) ToXML

func (message *IRODSMessagePluginAuthMessage) ToXML() ([]byte, error)

ToXML returns XML byte array

type IRODSMessageQuery

type IRODSMessageQuery 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"`
}

IRODSMessageQuery stores query

func NewIRODSMessageQuery

func NewIRODSMessageQuery(maxRows int, continueIndex int, partialStartIndex int, options int) *IRODSMessageQuery

NewIRODSMessageQuery creates a IRODSMessageQuery message

func (*IRODSMessageQuery) AddCondition

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

AddCondition adds a condition

func (*IRODSMessageQuery) AddKeyVal

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

AddKeyVal adds a key-value pair

func (*IRODSMessageQuery) AddSelect

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

AddSelect adds a column to select

func (*IRODSMessageQuery) FromBytes

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

FromBytes returns struct from bytes

func (*IRODSMessageQuery) GetBytes

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

GetBytes returns byte array

func (*IRODSMessageQuery) GetMessage

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

GetMessage builds a message

type IRODSMessageQueryResult

type IRODSMessageQueryResult 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:"-"`
}

IRODSMessageQueryResult stores query result

func (*IRODSMessageQueryResult) CheckError added in v0.5.1

func (msg *IRODSMessageQueryResult) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageQueryResult) FromBytes

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

FromBytes returns struct from bytes

func (*IRODSMessageQueryResult) FromMessage

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

FromMessage returns struct from IRODSMessage

func (*IRODSMessageQueryResult) GetBytes

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

GetBytes returns byte array

type IRODSMessageRawString

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

IRODSMessageRawString ...

type IRODSMessageReadobjRequest

type IRODSMessageReadobjRequest IRODSMessageOpenedDataObjectRequest

IRODSMessageReadobjRequest stores data object read request

func NewIRODSMessageReadobjRequest

func NewIRODSMessageReadobjRequest(desc int, len int) *IRODSMessageReadobjRequest

NewIRODSMessageReadobjRequest creates a IRODSMessageReadobjRequest message

func (*IRODSMessageReadobjRequest) AddKeyVal

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

AddKeyVal adds a key-value pair

func (*IRODSMessageReadobjRequest) FromBytes

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

FromBytes returns struct from bytes

func (*IRODSMessageReadobjRequest) GetBytes

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

GetBytes returns byte array

func (*IRODSMessageReadobjRequest) GetMessage

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

GetMessage builds a message

type IRODSMessageReadobjResponse

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

IRODSMessageReadobjResponse stores data object read response

func (*IRODSMessageReadobjResponse) CheckError

func (msg *IRODSMessageReadobjResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageReadobjResponse) FromMessage

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

FromMessage returns struct from IRODSMessage

type IRODSMessageReplobjRequest

type IRODSMessageReplobjRequest IRODSMessageDataObjectRequest

IRODSMessageReplobjRequest stores data object replication request

func NewIRODSMessageReplobjRequest

func NewIRODSMessageReplobjRequest(path string, resource string) *IRODSMessageReplobjRequest

NewIRODSMessageReplobjRequest creates a IRODSMessageReplobjRequest message

func (*IRODSMessageReplobjRequest) AddKeyVal

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

AddKeyVal adds a key-value pair

func (*IRODSMessageReplobjRequest) FromBytes

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

FromBytes returns struct from bytes

func (*IRODSMessageReplobjRequest) GetBytes

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

GetBytes returns byte array

func (*IRODSMessageReplobjRequest) GetMessage

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

GetMessage builds a message

type IRODSMessageReplobjResponse

type IRODSMessageReplobjResponse struct {
	// empty structure
	Result int
}

IRODSMessageReplobjResponse stores data object replication response

func (*IRODSMessageReplobjResponse) CheckError

func (msg *IRODSMessageReplobjResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageReplobjResponse) FromMessage

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

FromMessage returns struct from IRODSMessage

type IRODSMessageRmcolRequest

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

IRODSMessageRmcolRequest stores collection deletion request

func NewIRODSMessageRmcolRequest

func NewIRODSMessageRmcolRequest(name string, recurse bool, force bool) *IRODSMessageRmcolRequest

NewIRODSMessageRmcolRequest creates a IRODSMessageRmcolRequest message

func (*IRODSMessageRmcolRequest) AddKeyVal

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

AddKeyVal adds a key-value pair

func (*IRODSMessageRmcolRequest) FromBytes

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

FromBytes returns struct from bytes

func (*IRODSMessageRmcolRequest) GetBytes

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

GetBytes returns byte array

func (*IRODSMessageRmcolRequest) GetMessage

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

GetMessage builds a message

type IRODSMessageRmcolResponse

type IRODSMessageRmcolResponse struct {
	// empty structure
	Result int
}

IRODSMessageRmcolResponse stores collection deletion response

func (*IRODSMessageRmcolResponse) CheckError

func (msg *IRODSMessageRmcolResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageRmcolResponse) FromMessage

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

FromMessage returns struct from IRODSMessage

type IRODSMessageRmobjRequest

type IRODSMessageRmobjRequest IRODSMessageDataObjectRequest

IRODSMessageRmobjRequest stores data object deletion request

func NewIRODSMessageRmobjRequest

func NewIRODSMessageRmobjRequest(path string, force bool) *IRODSMessageRmobjRequest

NewIRODSMessageRmobjRequest creates a IRODSMessageRmobjRequest message

func (*IRODSMessageRmobjRequest) AddKeyVal

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

AddKeyVal adds a key-value pair

func (*IRODSMessageRmobjRequest) FromBytes

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

FromBytes returns struct from bytes

func (*IRODSMessageRmobjRequest) GetBytes

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

GetBytes returns byte array

func (*IRODSMessageRmobjRequest) GetMessage

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

GetMessage builds a message

type IRODSMessageRmobjResponse

type IRODSMessageRmobjResponse struct {
	// empty structure
	Result int
}

IRODSMessageRmobjResponse stores data object deletion response

func (*IRODSMessageRmobjResponse) CheckError

func (msg *IRODSMessageRmobjResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageRmobjResponse) FromMessage

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

FromMessage returns struct from IRODSMessage

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) 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) GetMessage

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

GetMessage builds a message

type IRODSMessageSeekobjRequest

type IRODSMessageSeekobjRequest IRODSMessageOpenedDataObjectRequest

IRODSMessageSeekobjRequest stores data object seek request

func NewIRODSMessageSeekobjRequest

func NewIRODSMessageSeekobjRequest(desc int, offset int64, whence types.Whence) *IRODSMessageSeekobjRequest

NewIRODSMessageSeekobjRequest creates a IRODSMessageSeekobjRequest message

func (*IRODSMessageSeekobjRequest) AddKeyVal

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

AddKeyVal adds a key-value pair

func (*IRODSMessageSeekobjRequest) FromBytes

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

FromBytes returns struct from bytes

func (*IRODSMessageSeekobjRequest) GetBytes

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

GetBytes returns byte array

func (*IRODSMessageSeekobjRequest) GetMessage

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

GetMessage builds a message

type IRODSMessageSeekobjResponse

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

IRODSMessageSeekobjResponse stores data object seek response

func (*IRODSMessageSeekobjResponse) CheckError

func (msg *IRODSMessageSeekobjResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageSeekobjResponse) FromBytes

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

FromBytes returns struct from bytes

func (*IRODSMessageSeekobjResponse) FromMessage

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

FromMessage returns struct from IRODSMessage

type IRODSMessageSerializationInterface

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

IRODSMessageSerializationInterface is an interface for serializaing/deserializing of message

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
	Ticket  string   `xml:"arg2"` // ticket number
	Arg3    string   `xml:"arg3"`
	Arg4    string   `xml:"arg4"`
	Arg5    string   `xml:"arg5"`
	Arg6    string   `xml:"arg6"`
}

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) 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 IRODSMessageTrimobjRequest added in v0.4.0

type IRODSMessageTrimobjRequest IRODSMessageDataObjectRequest

IRODSMessageTrimobjRequest stores data object replication request

func NewIRODSMessageTrimobjRequest added in v0.4.0

func NewIRODSMessageTrimobjRequest(path string, resource string, minCopies int, minAgeMinutes int) *IRODSMessageTrimobjRequest

NewIRODSMessageTrimobjRequest creates a IRODSMessageReplobjRequest message

func (*IRODSMessageTrimobjRequest) AddKeyVal added in v0.4.0

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

AddKeyVal adds a key-value pair

func (*IRODSMessageTrimobjRequest) FromBytes added in v0.4.0

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

FromBytes returns struct from bytes

func (*IRODSMessageTrimobjRequest) GetBytes added in v0.4.0

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

GetBytes returns byte array

func (*IRODSMessageTrimobjRequest) GetMessage added in v0.4.0

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

GetMessage builds a message

type IRODSMessageTrimobjResponse added in v0.4.0

type IRODSMessageTrimobjResponse struct {
	// empty structure
	Result int
}

IRODSMessageTrimobjResponse stores data object trim response

func (*IRODSMessageTrimobjResponse) CheckError added in v0.4.0

func (msg *IRODSMessageTrimobjResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageTrimobjResponse) FromMessage added in v0.4.0

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

FromMessage returns struct from IRODSMessage

type IRODSMessageTruncobjRequest

type IRODSMessageTruncobjRequest IRODSMessageDataObjectRequest

IRODSMessageTruncobjRequest stores data object truncation request

func NewIRODSMessageTruncobjRequest

func NewIRODSMessageTruncobjRequest(path string, size int64) *IRODSMessageTruncobjRequest

NewIRODSMessageTruncobjRequest creates a IRODSMessageTruncobjRequest message

func (*IRODSMessageTruncobjRequest) AddKeyVal

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

AddKeyVal adds a key-value pair

func (*IRODSMessageTruncobjRequest) FromBytes

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

FromBytes returns struct from bytes

func (*IRODSMessageTruncobjRequest) GetBytes

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

GetBytes returns byte array

func (*IRODSMessageTruncobjRequest) GetMessage

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

GetMessage builds a message

type IRODSMessageTruncobjResponse

type IRODSMessageTruncobjResponse struct {
	// empty structure
	Result int
}

IRODSMessageTruncobjResponse stores data object truncation response

func (*IRODSMessageTruncobjResponse) CheckError

func (msg *IRODSMessageTruncobjResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageTruncobjResponse) FromMessage

func (msg *IRODSMessageTruncobjResponse) 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:"reconnectAddr"`
	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) GetVersion

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

GetVersion creates IRODSVersion

type IRODSMessageWriteobjRequest

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

IRODSMessageWriteobjRequest stores data object read request type IRODSMessageWriteobjRequest IRODSMessageOpenedDataObjectRequest

func NewIRODSMessageWriteobjRequest

func NewIRODSMessageWriteobjRequest(desc int, data []byte) *IRODSMessageWriteobjRequest

NewIRODSMessageWriteobjRequest creates a IRODSMessageWriteobjRequest message

func (*IRODSMessageWriteobjRequest) AddKeyVal

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

AddKeyVal adds a key-value pair

func (*IRODSMessageWriteobjRequest) FromBytes

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

FromBytes returns struct from bytes

func (*IRODSMessageWriteobjRequest) GetBytes

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

GetBytes returns byte array

func (*IRODSMessageWriteobjRequest) GetMessage

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

GetMessage builds a message

type IRODSMessageWriteobjResponse

type IRODSMessageWriteobjResponse struct {
	// empty structure
	Result int
}

IRODSMessageWriteobjResponse stores data object write response

func (*IRODSMessageWriteobjResponse) CheckError

func (msg *IRODSMessageWriteobjResponse) CheckError() error

CheckError returns error if server returned an error

func (*IRODSMessageWriteobjResponse) FromMessage

func (msg *IRODSMessageWriteobjResponse) 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"
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL