memd

package
v9.1.11 Latest Latest
Warning

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

 Go to latest Published: Jun 18, 2024 License: Apache-2.0 Imports: 10 Imported by: 14

README

This memd library should be moved into gocbcore!

Documentation

Index

Constants

View Source 
const (
	CmdGet                        = CmdCode(0x00)
	CmdSet                        = CmdCode(0x01)
	CmdAdd                        = CmdCode(0x02)
	CmdReplace                    = CmdCode(0x03)
	CmdDelete                     = CmdCode(0x04)
	CmdIncrement                  = CmdCode(0x05)
	CmdDecrement                  = CmdCode(0x06)
	CmdNoop                       = CmdCode(0x0a)
	CmdAppend                     = CmdCode(0x0e)
	CmdPrepend                    = CmdCode(0x0f)
	CmdStat                       = CmdCode(0x10)
	CmdTouch                      = CmdCode(0x1c)
	CmdGAT                        = CmdCode(0x1d)
	CmdHello                      = CmdCode(0x1f)
	CmdSASLListMechs              = CmdCode(0x20)
	CmdSASLAuth                   = CmdCode(0x21)
	CmdSASLStep                   = CmdCode(0x22)
	CmdGetAllVBSeqnos             = CmdCode(0x48)
	CmdDcpOpenConnection          = CmdCode(0x50)
	CmdDcpAddStream               = CmdCode(0x51)
	CmdDcpCloseStream             = CmdCode(0x52)
	CmdDcpStreamReq               = CmdCode(0x53)
	CmdDcpGetFailoverLog          = CmdCode(0x54)
	CmdDcpStreamEnd               = CmdCode(0x55)
	CmdDcpSnapshotMarker          = CmdCode(0x56)
	CmdDcpMutation                = CmdCode(0x57)
	CmdDcpDeletion                = CmdCode(0x58)
	CmdDcpExpiration              = CmdCode(0x59)
	CmdDcpSeqNoAdvanced           = CmdCode(0x64)
	CmdDcpOsoSnapshot             = CmdCode(0x65)
	CmdDcpFlush                   = CmdCode(0x5a)
	CmdDcpSetVbucketState         = CmdCode(0x5b)
	CmdDcpNoop                    = CmdCode(0x5c)
	CmdDcpBufferAck               = CmdCode(0x5d)
	CmdDcpControl                 = CmdCode(0x5e)
	CmdDcpEvent                   = CmdCode(0x5f)
	CmdGetReplica                 = CmdCode(0x83)
	CmdSelectBucket               = CmdCode(0x89)
	CmdObserveSeqNo               = CmdCode(0x91)
	CmdObserve                    = CmdCode(0x92)
	CmdGetLocked                  = CmdCode(0x94)
	CmdUnlockKey                  = CmdCode(0x95)
	CmdGetMeta                    = CmdCode(0xa0)
	CmdSetMeta                    = CmdCode(0xa2)
	CmdDelMeta                    = CmdCode(0xa8)
	CmdGetClusterConfig           = CmdCode(0xb5)
	CmdGetRandom                  = CmdCode(0xb6)
	CmdCollectionsGetManifest     = CmdCode(0xba)
	CmdCollectionsGetID           = CmdCode(0xbb)
	CmdSubDocGet                  = CmdCode(0xc5)
	CmdSubDocExists               = CmdCode(0xc6)
	CmdSubDocDictAdd              = CmdCode(0xc7)
	CmdSubDocDictSet              = CmdCode(0xc8)
	CmdSubDocDelete               = CmdCode(0xc9)
	CmdSubDocReplace              = CmdCode(0xca)
	CmdSubDocArrayPushLast        = CmdCode(0xcb)
	CmdSubDocArrayPushFirst       = CmdCode(0xcc)
	CmdSubDocArrayInsert          = CmdCode(0xcd)
	CmdSubDocArrayAddUnique       = CmdCode(0xce)
	CmdSubDocCounter              = CmdCode(0xcf)
	CmdSubDocMultiLookup          = CmdCode(0xd0)
	CmdSubDocMultiMutation        = CmdCode(0xd1)
	CmdSubDocGetCount             = CmdCode(0xd2)
	CmdSubDocReplaceBodyWithXattr = CmdCode(0xd3)
	CmdGetErrorMap                = CmdCode(0xfe)
)

These constants provide predefined values for all the operations which are supported by this library.

View Source 
const (
	// CmdMagicReq indicates that the packet is a request.
	CmdMagicReq = CmdMagic(0x80)

	// CmdMagicRes indicates that the packet is a response.
	CmdMagicRes = CmdMagic(0x81)
)
View Source 
const (
	// FeatureDatatype indicates support for Datatype fields.
	FeatureDatatype = HelloFeature(0x01)

	// FeatureTLS indicates support for TLS
	FeatureTLS = HelloFeature(0x02)

	// FeatureTCPNoDelay indicates support for TCP no-delay.
	FeatureTCPNoDelay = HelloFeature(0x03)

	// FeatureSeqNo indicates support for mutation tokens.
	FeatureSeqNo = HelloFeature(0x04)

	// FeatureTCPDelay indicates support for TCP delay.
	FeatureTCPDelay = HelloFeature(0x05)

	// FeatureXattr indicates support for document xattrs.
	FeatureXattr = HelloFeature(0x06)

	// FeatureXerror indicates support for extended errors.
	FeatureXerror = HelloFeature(0x07)

	// FeatureSelectBucket indicates support for the SelectBucket operation.
	FeatureSelectBucket = HelloFeature(0x08)

	// FeatureSnappy indicates support for snappy compressed documents.
	FeatureSnappy = HelloFeature(0x0a)

	// FeatureJSON indicates support for JSON datatype data.
	FeatureJSON = HelloFeature(0x0b)

	// FeatureDuplex indicates support for duplex communications.
	FeatureDuplex = HelloFeature(0x0c)

	// FeatureClusterMapNotif indicates support for cluster-map update notifications.
	FeatureClusterMapNotif = HelloFeature(0x0d)

	// FeatureUnorderedExec indicates support for unordered execution of operations.
	FeatureUnorderedExec = HelloFeature(0x0e)

	// FeatureDurations indicates support for server durations.
	FeatureDurations = HelloFeature(0xf)

	// FeatureAltRequests indicates support for requests with flexible frame extras.
	FeatureAltRequests = HelloFeature(0x10)

	// FeatureSyncReplication indicates support for requests synchronous durability requirements.
	FeatureSyncReplication = HelloFeature(0x11)

	// FeatureCollections indicates support for collections.
	FeatureCollections = HelloFeature(0x12)

	// FeatureOpenTracing indicates support for OpenTracing.
	FeatureOpenTracing = HelloFeature(0x13)

	// FeatureCreateAsDeleted indicates support for the create as deleted feature.
	FeatureCreateAsDeleted = HelloFeature(0x17)

	// FeatureReplaceBodyWithXattr indicates support for the replace body with xattr feature.
	FeatureReplaceBodyWithXattr = HelloFeature(0x19)
)
View Source 
const (
	// StreamEndOK represents that the stream ended successfully.
	StreamEndOK = StreamEndStatus(0x00)

	// StreamEndClosed represents that the stream was forcefully closed.
	StreamEndClosed = StreamEndStatus(0x01)

	// StreamEndStateChanged represents that the stream was closed due to a state change.
	StreamEndStateChanged = StreamEndStatus(0x02)

	// StreamEndDisconnected represents that the stream was closed due to disconnection.
	StreamEndDisconnected = StreamEndStatus(0x03)

	// StreamEndTooSlow represents that the stream was closed due to the stream being too slow.
	StreamEndTooSlow = StreamEndStatus(0x04)

	// StreamEndBackfillFailed represents that the stream was closed due to backfill failing.
	StreamEndBackfillFailed = StreamEndStatus(0x05)

	// StreamEndFilterEmpty represents that the stream was closed due to the filter being empty.
	StreamEndFilterEmpty = StreamEndStatus(0x07)
)
View Source 
const (
	// StreamEventCollectionCreate is the StreamEventCode for a collection create event
	StreamEventCollectionCreate = StreamEventCode(0x00)

	// StreamEventCollectionDelete is the StreamEventCode for a collection delete event
	StreamEventCollectionDelete = StreamEventCode(0x01)

	// StreamEventCollectionFlush is the StreamEventCode for a collection flush event
	StreamEventCollectionFlush = StreamEventCode(0x02)

	// StreamEventScopeCreate is the StreamEventCode for a scope create event
	StreamEventScopeCreate = StreamEventCode(0x03)

	// StreamEventScopeDelete is the StreamEventCode for a scope delete event
	StreamEventScopeDelete = StreamEventCode(0x04)

	// StreamEventCollectionChanged is the StreamEventCode for a collection changed event
	StreamEventCollectionChanged = StreamEventCode(0x05)
)
View Source 
const (
	// VbucketStateActive indicates the vbucket is active on this server
	VbucketStateActive = VbucketState(0x01)

	// VbucketStateReplica indicates the vbucket is a replica on this server
	VbucketStateReplica = VbucketState(0x02)

	// VbucketStatePending indicates the vbucket is preparing to become active on this server.
	VbucketStatePending = VbucketState(0x03)

	// VbucketStateDead indicates the vbucket is no longer valid on this server.
	VbucketStateDead = VbucketState(0x04)
)
View Source 
const (
	// ForceMetaOp disables conflict resolution for the document and allows the
	// operation to be applied to an active, pending, or replica vbucket.
	ForceMetaOp = SetMetaOption(0x01)

	// UseLwwConflictResolution switches to Last-Write-Wins conflict resolution
	// for the document.
	UseLwwConflictResolution = SetMetaOption(0x02)

	// RegenerateCas causes the server to invalidate the current CAS value for
	// a document, and to generate a new one.
	RegenerateCas = SetMetaOption(0x04)

	// SkipConflictResolution disables conflict resolution for the document.
	SkipConflictResolution = SetMetaOption(0x08)

	// IsExpiration indicates that the message is for an expired document.
	IsExpiration = SetMetaOption(0x10)
)
View Source 
const (
	// KeyStateNotPersisted indicates the key is in memory, but not yet written to disk.
	KeyStateNotPersisted = KeyState(0x00)

	// KeyStatePersisted indicates that the key has been written to disk.
	KeyStatePersisted = KeyState(0x01)

	// KeyStateNotFound indicates that the key is not found in memory or on disk.
	KeyStateNotFound = KeyState(0x80)

	// KeyStateDeleted indicates that the key has been written to disk as deleted.
	KeyStateDeleted = KeyState(0x81)
)
View Source 
const (
	// SubDocOpGet indicates the operation is a sub-document `Get` operation.
	SubDocOpGet = SubDocOpType(CmdSubDocGet)

	// SubDocOpExists indicates the operation is a sub-document `Exists` operation.
	SubDocOpExists = SubDocOpType(CmdSubDocExists)

	// SubDocOpGetCount indicates the operation is a sub-document `GetCount` operation.
	SubDocOpGetCount = SubDocOpType(CmdSubDocGetCount)

	// SubDocOpDictAdd indicates the operation is a sub-document `Add` operation.
	SubDocOpDictAdd = SubDocOpType(CmdSubDocDictAdd)

	// SubDocOpDictSet indicates the operation is a sub-document `Set` operation.
	SubDocOpDictSet = SubDocOpType(CmdSubDocDictSet)

	// SubDocOpDelete indicates the operation is a sub-document `Remove` operation.
	SubDocOpDelete = SubDocOpType(CmdSubDocDelete)

	// SubDocOpReplace indicates the operation is a sub-document `Replace` operation.
	SubDocOpReplace = SubDocOpType(CmdSubDocReplace)

	// SubDocOpArrayPushLast indicates the operation is a sub-document `ArrayPushLast` operation.
	SubDocOpArrayPushLast = SubDocOpType(CmdSubDocArrayPushLast)

	// SubDocOpArrayPushFirst indicates the operation is a sub-document `ArrayPushFirst` operation.
	SubDocOpArrayPushFirst = SubDocOpType(CmdSubDocArrayPushFirst)

	// SubDocOpArrayInsert indicates the operation is a sub-document `ArrayInsert` operation.
	SubDocOpArrayInsert = SubDocOpType(CmdSubDocArrayInsert)

	// SubDocOpArrayAddUnique indicates the operation is a sub-document `ArrayAddUnique` operation.
	SubDocOpArrayAddUnique = SubDocOpType(CmdSubDocArrayAddUnique)

	// SubDocOpCounter indicates the operation is a sub-document `Counter` operation.
	SubDocOpCounter = SubDocOpType(CmdSubDocCounter)

	// SubDocOpGetDoc represents a full document retrieval, for use with extended attribute ops.
	SubDocOpGetDoc = SubDocOpType(CmdGet)

	// SubDocOpSetDoc represents a full document set, for use with extended attribute ops.
	SubDocOpSetDoc = SubDocOpType(CmdSet)

	// SubDocOpAddDoc represents a full document add, for use with extended attribute ops.
	SubDocOpAddDoc = SubDocOpType(CmdAdd)

	// SubDocOpDeleteDoc represents a full document delete, for use with extended attribute ops.
	SubDocOpDeleteDoc = SubDocOpType(CmdDelete)

	// SubDocOpReplaceBodyWithXattr represents a replace body with xattr op.
	// Uncommitted: This API may change in the future.
	SubDocOpReplaceBodyWithXattr = SubDocOpType(CmdSubDocReplaceBodyWithXattr)
)
View Source 
const (
	// DcpOpenFlagProducer indicates this connection wants the other end to be a producer.
	DcpOpenFlagProducer = DcpOpenFlag(0x01)

	// DcpOpenFlagNotifier indicates this connection wants the other end to be a notifier.
	DcpOpenFlagNotifier = DcpOpenFlag(0x02)

	// DcpOpenFlagIncludeXattrs indicates the client wishes to receive extended attributes.
	DcpOpenFlagIncludeXattrs = DcpOpenFlag(0x04)

	// DcpOpenFlagNoValue indicates the client does not wish to receive mutation values.
	DcpOpenFlagNoValue = DcpOpenFlag(0x08)

	// DcpOpenFlagIncludeDeleteTimes indicates the client wishes to receive delete times.
	DcpOpenFlagIncludeDeleteTimes = DcpOpenFlag(0x20)
)
View Source 
const (
	//DcpStreamAddFlagDiskOnly indicates that stream should only send items if they are on disk
	DcpStreamAddFlagDiskOnly = DcpStreamAddFlag(0x02)

	// DcpStreamAddFlagLatest indicates this stream wants to get data up to the latest seqno.
	DcpStreamAddFlagLatest = DcpStreamAddFlag(0x04)

	// DcpStreamAddFlagActiveOnly indicates this stream should only connect to an active vbucket.
	DcpStreamAddFlagActiveOnly = DcpStreamAddFlag(0x10)

	// DcpStreamAddFlagStrictVBUUID indicates the vbuuid must match unless the start seqno
	// is 0 and the vbuuid is also 0.
	DcpStreamAddFlagStrictVBUUID = DcpStreamAddFlag(0x20)
)
View Source 
const (
	// DatatypeFlagJSON indicates the server believes the value payload to be JSON.
	DatatypeFlagJSON = DatatypeFlag(0x01)

	// DatatypeFlagCompressed indicates the value payload is compressed.
	DatatypeFlagCompressed = DatatypeFlag(0x02)

	// DatatypeFlagXattrs indicates the inclusion of xattr data in the value payload.
	DatatypeFlagXattrs = DatatypeFlag(0x04)
)
View Source 
const (
	// SubdocFlagNone indicates no special treatment for this operation.
	SubdocFlagNone = SubdocFlag(0x00)

	// SubdocFlagMkDirP indicates that the path should be created if it does not already exist.
	SubdocFlagMkDirP = SubdocFlag(0x01)

	// SubdocFlagXattrPath indicates that the path refers to an Xattr rather than the document body.
	SubdocFlagXattrPath = SubdocFlag(0x04)

	// SubdocFlagExpandMacros indicates that the value portion of any sub-document mutations
	// should be expanded if they contain macros such as ${Mutation.CAS}.
	SubdocFlagExpandMacros = SubdocFlag(0x10)
)
View Source 
const (
	// SubdocDocFlagNone indicates no special treatment for this operation.
	SubdocDocFlagNone = SubdocDocFlag(0x00)

	// SubdocDocFlagMkDoc indicates that the document should be created if it does not already exist.
	SubdocDocFlagMkDoc = SubdocDocFlag(0x01)

	// SubdocDocFlagAddDoc indices that this operation should be an add rather than set.
	SubdocDocFlagAddDoc = SubdocDocFlag(0x02)

	// SubdocDocFlagAccessDeleted indicates that you wish to receive soft-deleted documents.
	// Internal: This should never be used and is not supported.
	SubdocDocFlagAccessDeleted = SubdocDocFlag(0x04)

	// SubdocDocFlagCreateAsDeleted indicates that the document should be created as deleted.
	// That is, to create a tombstone only.
	// Internal: This should never be used and is not supported.
	SubdocDocFlagCreateAsDeleted = SubdocDocFlag(0x08)
)
View Source 
const (
	// DurabilityLevelMajority specifies that a change must be replicated to (held in memory)
	// a majority of the nodes for the bucket.
	DurabilityLevelMajority = DurabilityLevel(0x01)

	// DurabilityLevelMajorityAndPersistOnMaster specifies that a change must be replicated to (held in memory)
	// a majority of the nodes for the bucket and additionally persisted to disk on the active node.
	DurabilityLevelMajorityAndPersistOnMaster = DurabilityLevel(0x02)

	// DurabilityLevelPersistToMajority specifies that a change must be persisted to (written to disk)
	// a majority for the bucket.
	DurabilityLevelPersistToMajority = DurabilityLevel(0x03)
)
View Source 
const (
	// StatusSuccess indicates the operation completed successfully.
	StatusSuccess = StatusCode(0x00)

	// StatusKeyNotFound occurs when an operation is performed on a key that does not exist.
	StatusKeyNotFound = StatusCode(0x01)

	// StatusKeyExists occurs when an operation is performed on a key that could not be found.
	StatusKeyExists = StatusCode(0x02)

	// StatusTooBig occurs when an operation attempts to store more data in a single document
	// than the server is capable of storing (by default, this is a 20MB limit).
	StatusTooBig = StatusCode(0x03)

	// StatusInvalidArgs occurs when the server receives invalid arguments for an operation.
	StatusInvalidArgs = StatusCode(0x04)

	// StatusNotStored occurs when the server fails to store a key.
	StatusNotStored = StatusCode(0x05)

	// StatusBadDelta occurs when an invalid delta value is specified to a counter operation.
	StatusBadDelta = StatusCode(0x06)

	// StatusNotMyVBucket occurs when an operation is dispatched to a server which is
	// non-authoritative for a specific vbucket.
	StatusNotMyVBucket = StatusCode(0x07)

	// StatusNoBucket occurs when no bucket was selected on a connection.
	StatusNoBucket = StatusCode(0x08)

	// StatusLocked occurs when an operation fails due to the document being locked.
	StatusLocked = StatusCode(0x09)

	// StatusAuthStale occurs when authentication credentials have become invalidated.
	StatusAuthStale = StatusCode(0x1f)

	// StatusAuthError occurs when the authentication information provided was not valid.
	StatusAuthError = StatusCode(0x20)

	// StatusAuthContinue occurs in multi-step authentication when more authentication
	// work needs to be performed in order to complete the authentication process.
	StatusAuthContinue = StatusCode(0x21)

	// StatusRangeError occurs when the range specified to the server is not valid.
	StatusRangeError = StatusCode(0x22)

	// StatusRollback occurs when a DCP stream fails to open due to a rollback having
	// previously occurred since the last time the stream was opened.
	StatusRollback = StatusCode(0x23)

	// StatusAccessError occurs when an access error occurs.
	StatusAccessError = StatusCode(0x24)

	// StatusNotInitialized is sent by servers which are still initializing, and are not
	// yet ready to accept operations on behalf of a particular bucket.
	StatusNotInitialized = StatusCode(0x25)

	// StatusUnknownCommand occurs when an unknown operation is sent to a server.
	StatusUnknownCommand = StatusCode(0x81)

	// StatusOutOfMemory occurs when the server cannot service a request due to memory
	// limitations.
	StatusOutOfMemory = StatusCode(0x82)

	// StatusNotSupported occurs when an operation is understood by the server, but that
	// operation is not supported on this server (occurs for a variety of reasons).
	StatusNotSupported = StatusCode(0x83)

	// StatusInternalError occurs when internal errors prevent the server from processing
	// your request.
	StatusInternalError = StatusCode(0x84)

	// StatusBusy occurs when the server is too busy to process your request right away.
	// Attempting the operation at a later time will likely succeed.
	StatusBusy = StatusCode(0x85)

	// StatusTmpFail occurs when a temporary failure is preventing the server from
	// processing your request.
	StatusTmpFail = StatusCode(0x86)

	// StatusCollectionUnknown occurs when a Collection cannot be found.
	StatusCollectionUnknown = StatusCode(0x88)

	// StatusScopeUnknown occurs when a Scope cannot be found.
	StatusScopeUnknown = StatusCode(0x8c)

	// StatusDCPStreamIDInvalid occurs when a dcp stream ID is invalid.
	StatusDCPStreamIDInvalid = StatusCode(0x8d)

	// StatusDurabilityInvalidLevel occurs when an invalid durability level was requested.
	StatusDurabilityInvalidLevel = StatusCode(0xa0)

	// StatusDurabilityImpossible occurs when a request is performed with impossible
	// durability level requirements.
	StatusDurabilityImpossible = StatusCode(0xa1)

	// StatusSyncWriteInProgress occurs when an attempt is made to write to a key that has
	// a SyncWrite pending.
	StatusSyncWriteInProgress = StatusCode(0xa2)

	// StatusSyncWriteAmbiguous occurs when an SyncWrite does not complete in the specified
	// time and the result is ambiguous.
	StatusSyncWriteAmbiguous = StatusCode(0xa3)

	// StatusSyncWriteReCommitInProgress occurs when an SyncWrite is being recommitted.
	StatusSyncWriteReCommitInProgress = StatusCode(0xa4)

	// StatusSubDocPathNotFound occurs when a sub-document operation targets a path
	// which does not exist in the specifie document.
	StatusSubDocPathNotFound = StatusCode(0xc0)

	// StatusSubDocPathMismatch occurs when a sub-document operation specifies a path
	// which does not match the document structure (field access on an array).
	StatusSubDocPathMismatch = StatusCode(0xc1)

	// StatusSubDocPathInvalid occurs when a sub-document path could not be parsed.
	StatusSubDocPathInvalid = StatusCode(0xc2)

	// StatusSubDocPathTooBig occurs when a sub-document path is too big.
	StatusSubDocPathTooBig = StatusCode(0xc3)

	// StatusSubDocDocTooDeep occurs when an operation would cause a document to be
	// nested beyond the depth limits allowed by the sub-document specification.
	StatusSubDocDocTooDeep = StatusCode(0xc4)

	// StatusSubDocCantInsert occurs when a sub-document operation could not insert.
	StatusSubDocCantInsert = StatusCode(0xc5)

	// StatusSubDocNotJSON occurs when a sub-document operation is performed on a
	// document which is not JSON.
	StatusSubDocNotJSON = StatusCode(0xc6)

	// StatusSubDocBadRange occurs when a sub-document operation is performed with
	// a bad range.
	StatusSubDocBadRange = StatusCode(0xc7)

	// StatusSubDocBadDelta occurs when a sub-document counter operation is performed
	// and the specified delta is not valid.
	StatusSubDocBadDelta = StatusCode(0xc8)

	// StatusSubDocPathExists occurs when a sub-document operation expects a path not
	// to exists, but the path was found in the document.
	StatusSubDocPathExists = StatusCode(0xc9)

	// StatusSubDocValueTooDeep occurs when a sub-document operation specifies a value
	// which is deeper than the depth limits of the sub-document specification.
	StatusSubDocValueTooDeep = StatusCode(0xca)

	// StatusSubDocBadCombo occurs when a multi-operation sub-document operation is
	// performed and operations within the package of ops conflict with each other.
	StatusSubDocBadCombo = StatusCode(0xcb)

	// StatusSubDocBadMulti occurs when a multi-operation sub-document operation is
	// performed and operations within the package of ops conflict with each other.
	StatusSubDocBadMulti = StatusCode(0xcc)

	// StatusSubDocSuccessDeleted occurs when a multi-operation sub-document operation
	// is performed on a soft-deleted document.
	StatusSubDocSuccessDeleted = StatusCode(0xcd)

	// StatusSubDocXattrInvalidFlagCombo occurs when an invalid set of
	// extended-attribute flags is passed to a sub-document operation.
	StatusSubDocXattrInvalidFlagCombo = StatusCode(0xce)

	// StatusSubDocXattrInvalidKeyCombo occurs when an invalid set of key operations
	// are specified for a extended-attribute sub-document operation.
	StatusSubDocXattrInvalidKeyCombo = StatusCode(0xcf)

	// StatusSubDocXattrUnknownMacro occurs when an invalid macro value is specified.
	StatusSubDocXattrUnknownMacro = StatusCode(0xd0)

	// StatusSubDocXattrUnknownVAttr occurs when an invalid virtual attribute is specified.
	StatusSubDocXattrUnknownVAttr = StatusCode(0xd1)

	// StatusSubDocXattrCannotModifyVAttr occurs when a mutation is attempted upon
	// a virtual attribute (which are immutable by definition).
	StatusSubDocXattrCannotModifyVAttr = StatusCode(0xd2)

	// StatusSubDocMultiPathFailureDeleted occurs when a Multi Path Failure occurs on
	// a soft-deleted document.
	StatusSubDocMultiPathFailureDeleted = StatusCode(0xd3)
)

Variables

This section is empty.

Functions

func AppendULEB128_32 

func AppendULEB128_32(b []byte, v uint32) []byte

AppendULEB128_32 appends a 32-bit number encoded as ULEB128 to a byte slice

func DecodeSrvDura16 

func DecodeSrvDura16(enc uint16) time.Duration

DecodeSrvDura16 takes an encoded operation duration from the server and converts it to a standard Go time duration.

func DecodeULEB128_32 

func DecodeULEB128_32(b []byte) (uint32, int, error)

DecodeULEB128_32 decodes a ULEB128 encoded number into a uint32

func EncodeSrvDura16 

func EncodeSrvDura16(dura time.Duration) uint16

EncodeSrvDura16 takes a standard go time duration and encodes it into the appropriate format for the server.

func IsCommandCollectionEncoded 

func IsCommandCollectionEncoded(cmd CmdCode) bool

IsCommandCollectionEncoded returns whether a particular command code should have its key collection encoded when collections support is enabled for a particular connection

func ReleasePacket added in v9.1.3 

func ReleasePacket(packet *Packet)

ReleasePacket - Return a packet to the internal pool. Note that the packet will be reset, removing any active pointers to existing data structures.

Types

type BarrierFrame 

type BarrierFrame struct {
}

BarrierFrame is used to signal to the server that this command should be barriered and must not be executed concurrently with other commands.

type CmdCode 

type CmdCode uint8

CmdCode represents the specific command the packet is performing.

func (CmdCode) Name 

func (command CmdCode) Name() string

Name returns the string representation of the CmdCode.

type CmdMagic 

type CmdMagic uint8

CmdMagic represents the magic number that begins the header of every packet and informs the rest of the header format.

type Conn 

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

Conn represents a memcached protocol connection.

func NewConn 

func NewConn(stream io.ReadWriter) *Conn

NewConn creates a new connection object which can be used to perform reading and writing of packets.

func (*Conn) EnableFeature 

func (c *Conn) EnableFeature(feature HelloFeature)

EnableFeature enables a particular feature on this connection.

func (*Conn) IsFeatureEnabled 

func (c *Conn) IsFeatureEnabled(feature HelloFeature) bool

IsFeatureEnabled indicates whether a particular feature is enabled on this particular connection. Note that this is directly based on calls to EnableFeature and is not controlled by the library.

func (*Conn) ReadPacket 

func (c *Conn) ReadPacket() (*Packet, int, error)

ReadPacket reads a packet from the network.

func (*Conn) WritePacket 

func (c *Conn) WritePacket(pkt *Packet) error

WritePacket writes a packet to the network.

type DatatypeFlag 

type DatatypeFlag uint8

DatatypeFlag specifies data flags for the value of a document.

type DcpOpenFlag 

type DcpOpenFlag uint32

DcpOpenFlag specifies flags for DCP connections configured when the stream is opened.

type DcpStreamAddFlag 

type DcpStreamAddFlag uint32

DcpStreamAddFlag specifies flags for DCP streams configured when the stream is opened.

type DurabilityLevel 

type DurabilityLevel uint8

DurabilityLevel specifies the level to use for enhanced durability requirements.

type DurabilityLevelFrame 

type DurabilityLevelFrame struct {
	DurabilityLevel DurabilityLevel
}

DurabilityLevelFrame allows you to specify a durability level for an operation through the frame extras.

type DurabilityTimeoutFrame 

type DurabilityTimeoutFrame struct {
	DurabilityTimeout time.Duration
}

DurabilityTimeoutFrame allows you to specify a specific timeout for durability operations to timeout. Note that this frame is actually an extension of DurabilityLevelFrame and requires that frame to also be used in order to function.

type HelloFeature 

type HelloFeature uint16

HelloFeature represents a feature code included in a memcached HELLO operation.

type KeyState 

type KeyState uint8

KeyState represents the various storage states of a key on the server.

type OpenTracingFrame 

type OpenTracingFrame struct {
	TraceContext []byte
}

OpenTracingFrame allows open tracing context information to be included along with a command which is being performed.

type Packet 

type Packet struct {
	Magic        CmdMagic
	Command      CmdCode
	Datatype     uint8
	Status       StatusCode
	Vbucket      uint16
	Opaque       uint32
	Cas          uint64
	CollectionID uint32
	Key          []byte
	Extras       []byte
	Value        []byte

	BarrierFrame           *BarrierFrame
	DurabilityLevelFrame   *DurabilityLevelFrame
	DurabilityTimeoutFrame *DurabilityTimeoutFrame
	StreamIDFrame          *StreamIDFrame
	OpenTracingFrame       *OpenTracingFrame
	ServerDurationFrame    *ServerDurationFrame
	UserImpersonationFrame *UserImpersonationFrame
	UnsupportedFrames      []UnsupportedFrame
}

Packet represents a single request or response packet being exchanged between two clients.

func AcquirePacket added in v9.1.3 

func AcquirePacket() *Packet

AcquirePacket - Retrieve a packet from the internal pool. Note that the packet should be returned to the pool to avoid unnecessary allocations.

type ServerDurationFrame 

type ServerDurationFrame struct {
	ServerDuration time.Duration
}

ServerDurationFrame allows the server to return information about the period of time an operation took to complete.

type SetMetaOption 

type SetMetaOption uint32

SetMetaOption represents possible option values for a SetMeta operation.

type StatusCode 

type StatusCode uint16

StatusCode represents a memcached response status.

func (StatusCode) KVText 

func (code StatusCode) KVText() string

KVText returns the textual representation of this StatusCode.

type StreamEndStatus 

type StreamEndStatus uint32

StreamEndStatus represents the reason for a DCP stream ending

func (StreamEndStatus) KVText 

func (code StreamEndStatus) KVText() string

KVText returns the textual representation of this StreamEndStatus.

type StreamEventCode 

type StreamEventCode uint32

StreamEventCode is the code for a DCP Stream event

type StreamIDFrame 

type StreamIDFrame struct {
	StreamID uint16
}

StreamIDFrame provides information about which stream this particular operation is related to (used for DCP streams).

type SubDocOpType 

type SubDocOpType uint8

SubDocOpType specifies the type of a sub-document operation.

type SubdocDocFlag 

type SubdocDocFlag uint8

SubdocDocFlag specifies document-level flags for a sub-document operation.

type SubdocFlag 

type SubdocFlag uint8

SubdocFlag specifies flags for a sub-document operation.

type UnsupportedFrame 

type UnsupportedFrame struct {
	Type frameType
	Data []byte
}

UnsupportedFrame is used to include an unsupported frame type in the packet data to enable further processing if needed.

type UserImpersonationFrame added in v9.1.0 

type UserImpersonationFrame struct {
	User []byte
}

UserImpersonationFrame is used to indicate a user to impersonate. Internal: This should never be used and is not supported.

type VbucketState 

type VbucketState uint32

VbucketState represents the state of a particular vbucket on a particular server.

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.