Documentation ¶
Index ¶
- Variables
- type CreateQueueRequest
- func (*CreateQueueRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateQueueRequest) GetQueueName() string
- func (*CreateQueueRequest) ProtoMessage()
- func (x *CreateQueueRequest) ProtoReflect() protoreflect.Message
- func (x *CreateQueueRequest) Reset()
- func (x *CreateQueueRequest) String() string
- type CreateQueueResponse
- func (*CreateQueueResponse) Descriptor() ([]byte, []int)deprecated
- func (x *CreateQueueResponse) GetId() *v1.IdRaw
- func (*CreateQueueResponse) ProtoMessage()
- func (x *CreateQueueResponse) ProtoReflect() protoreflect.Message
- func (x *CreateQueueResponse) Reset()
- func (x *CreateQueueResponse) String() string
- type DefQueue
- type DefQueueMsg
- type DefRow
- type DeleteQueueRequest
- func (*DeleteQueueRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DeleteQueueRequest) GetId() *v1.IdRaw
- func (*DeleteQueueRequest) ProtoMessage()
- func (x *DeleteQueueRequest) ProtoReflect() protoreflect.Message
- func (x *DeleteQueueRequest) Reset()
- func (x *DeleteQueueRequest) String() string
- type DeleteQueueResponse
- func (*DeleteQueueResponse) Descriptor() ([]byte, []int)deprecated
- func (x *DeleteQueueResponse) GetId() *v1.IdRaw
- func (*DeleteQueueResponse) ProtoMessage()
- func (x *DeleteQueueResponse) ProtoReflect() protoreflect.Message
- func (x *DeleteQueueResponse) Reset()
- func (x *DeleteQueueResponse) String() string
- type LengthRequest
- type LengthResponse
- func (*LengthResponse) Descriptor() ([]byte, []int)deprecated
- func (x *LengthResponse) GetId() *v1.IdRaw
- func (x *LengthResponse) GetLength() int64
- func (*LengthResponse) ProtoMessage()
- func (x *LengthResponse) ProtoReflect() protoreflect.Message
- func (x *LengthResponse) Reset()
- func (x *LengthResponse) String() string
- type LocateRequest
- type LocateResponse
- type MarkDoneRequest
- func (*MarkDoneRequest) Descriptor() ([]byte, []int)deprecated
- func (x *MarkDoneRequest) GetId() *v1.IdRaw
- func (x *MarkDoneRequest) GetMsg() []*v1.IdRaw
- func (*MarkDoneRequest) ProtoMessage()
- func (x *MarkDoneRequest) ProtoReflect() protoreflect.Message
- func (x *MarkDoneRequest) Reset()
- func (x *MarkDoneRequest) String() string
- type MarkDoneResponse
- func (*MarkDoneResponse) Descriptor() ([]byte, []int)deprecated
- func (x *MarkDoneResponse) GetId() *v1.IdRaw
- func (x *MarkDoneResponse) GetUnmodified() []*v1.IdRaw
- func (*MarkDoneResponse) ProtoMessage()
- func (x *MarkDoneResponse) ProtoReflect() protoreflect.Message
- func (x *MarkDoneResponse) Reset()
- func (x *MarkDoneResponse) String() string
- type QueueErr
- type QueueId
- func (f QueueId) Equal(other QueueId) bool
- func (f QueueId) High() uint64
- func (f QueueId) IsEmptyValue() bool
- func (f QueueId) IsZeroOrEmptyValue() bool
- func (f QueueId) IsZeroValue() bool
- func (f QueueId) Low() uint64
- func (f QueueId) Marshal() *protosupport.IdRaw
- func (f QueueId) Short() string
- func (f QueueId) String() string
- type QueueMsg
- func (*QueueMsg) Descriptor() ([]byte, []int)deprecated
- func (x *QueueMsg) GetId() *v1.IdRaw
- func (x *QueueMsg) GetMsgId() *v1.IdRaw
- func (x *QueueMsg) GetPayload() *anypb.Any
- func (x *QueueMsg) GetReceiveCount() int32
- func (x *QueueMsg) GetReceived() *timestamppb.Timestamp
- func (x *QueueMsg) GetSender() *anypb.Any
- func (x *QueueMsg) GetSent() *timestamppb.Timestamp
- func (*QueueMsg) ProtoMessage()
- func (x *QueueMsg) ProtoReflect() protoreflect.Message
- func (x *QueueMsg) Reset()
- func (x *QueueMsg) String() string
- type QueueMsgId
- func (f QueueMsgId) Equal(other QueueMsgId) bool
- func (f QueueMsgId) High() uint64
- func (f QueueMsgId) IsEmptyValue() bool
- func (f QueueMsgId) IsZeroOrEmptyValue() bool
- func (f QueueMsgId) IsZeroValue() bool
- func (f QueueMsgId) Low() uint64
- func (f QueueMsgId) Marshal() *protosupport.IdRaw
- func (f QueueMsgId) Short() string
- func (f QueueMsgId) String() string
- type ReceiveRequest
- func (*ReceiveRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ReceiveRequest) GetId() *v1.IdRaw
- func (x *ReceiveRequest) GetMessageLimit() int32
- func (*ReceiveRequest) ProtoMessage()
- func (x *ReceiveRequest) ProtoReflect() protoreflect.Message
- func (x *ReceiveRequest) Reset()
- func (x *ReceiveRequest) String() string
- type ReceiveResponse
- func (*ReceiveResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ReceiveResponse) GetId() *v1.IdRaw
- func (x *ReceiveResponse) GetMessage() []*QueueMsg
- func (*ReceiveResponse) ProtoMessage()
- func (x *ReceiveResponse) ProtoReflect() protoreflect.Message
- func (x *ReceiveResponse) Reset()
- func (x *ReceiveResponse) String() string
- type RowId
- func (f RowId) Equal(other RowId) bool
- func (f RowId) High() uint64
- func (f RowId) IsEmptyValue() bool
- func (f RowId) IsZeroOrEmptyValue() bool
- func (f RowId) IsZeroValue() bool
- func (f RowId) Low() uint64
- func (f RowId) Marshal() *protosupport.IdRaw
- func (f RowId) Short() string
- func (f RowId) String() string
- type SendRequest
- func (*SendRequest) Descriptor() ([]byte, []int)deprecated
- func (x *SendRequest) GetId() *v1.IdRaw
- func (x *SendRequest) GetMsg() []*QueueMsg
- func (*SendRequest) ProtoMessage()
- func (x *SendRequest) ProtoReflect() protoreflect.Message
- func (x *SendRequest) Reset()
- func (x *SendRequest) String() string
- type SendResponse
- func (*SendResponse) Descriptor() ([]byte, []int)deprecated
- func (x *SendResponse) GetFail() []*QueueMsg
- func (x *SendResponse) GetFailedOn() *v1.IdRaw
- func (x *SendResponse) GetSucceed() []*v1.IdRaw
- func (*SendResponse) ProtoMessage()
- func (x *SendResponse) ProtoReflect() protoreflect.Message
- func (x *SendResponse) Reset()
- func (x *SendResponse) String() string
Constants ¶
This section is empty.
Variables ¶
var ( QueueErr_name = map[int32]string{ 0: "NoError", 1: "DispatchError", 2: "UnmarshalError", 3: "MarshalError", 4: "InvalidName", 5: "InternalError", 6: "NoPayload", 7: "NotFound", 8: "AlreadyExists", 9: "UnmarshalFailed", } QueueErr_value = map[string]int32{ "NoError": 0, "DispatchError": 1, "UnmarshalError": 2, "MarshalError": 3, "InvalidName": 4, "InternalError": 5, "NoPayload": 6, "NotFound": 7, "AlreadyExists": 8, "UnmarshalFailed": 9, } )
Enum value maps for QueueErr.
var File_queue_v1_queue_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type CreateQueueRequest ¶
type CreateQueueRequest struct { QueueName string `protobuf:"bytes,1,opt,name=queue_name,json=queueName,proto3" json:"queue_name,omitempty"` // contains filtered or unexported fields }
Create creates a queue or returns an error. Note that this is usually used only once to set up the operating environment.
func (*CreateQueueRequest) Descriptor
deprecated
func (*CreateQueueRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateQueueRequest.ProtoReflect.Descriptor instead.
func (*CreateQueueRequest) GetQueueName ¶
func (x *CreateQueueRequest) GetQueueName() string
func (*CreateQueueRequest) ProtoMessage ¶
func (*CreateQueueRequest) ProtoMessage()
func (*CreateQueueRequest) ProtoReflect ¶
func (x *CreateQueueRequest) ProtoReflect() protoreflect.Message
func (*CreateQueueRequest) Reset ¶
func (x *CreateQueueRequest) Reset()
func (*CreateQueueRequest) String ¶
func (x *CreateQueueRequest) String() string
type CreateQueueResponse ¶
type CreateQueueResponse struct { Id *v1.IdRaw `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // contains filtered or unexported fields }
CreateQueueResponse returns the queue just created. Errors are passed back out of band.
func (*CreateQueueResponse) Descriptor
deprecated
func (*CreateQueueResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateQueueResponse.ProtoReflect.Descriptor instead.
func (*CreateQueueResponse) GetId ¶
func (x *CreateQueueResponse) GetId() *v1.IdRaw
func (*CreateQueueResponse) ProtoMessage ¶
func (*CreateQueueResponse) ProtoMessage()
func (*CreateQueueResponse) ProtoReflect ¶
func (x *CreateQueueResponse) ProtoReflect() protoreflect.Message
func (*CreateQueueResponse) Reset ¶
func (x *CreateQueueResponse) Reset()
func (*CreateQueueResponse) String ¶
func (x *CreateQueueResponse) String() string
type DefQueueMsg ¶
type DefQueueMsg struct{}
func (DefQueueMsg) Letter ¶
func (f DefQueueMsg) Letter() byte
func (DefQueueMsg) ShortString ¶
func (f DefQueueMsg) ShortString() string
type DeleteQueueRequest ¶
type DeleteQueueRequest struct { Id *v1.IdRaw `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // contains filtered or unexported fields }
Delete queue deletes a queue and returns the queue id deleted, or sends an error out of band.
func (*DeleteQueueRequest) Descriptor
deprecated
func (*DeleteQueueRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteQueueRequest.ProtoReflect.Descriptor instead.
func (*DeleteQueueRequest) GetId ¶
func (x *DeleteQueueRequest) GetId() *v1.IdRaw
func (*DeleteQueueRequest) ProtoMessage ¶
func (*DeleteQueueRequest) ProtoMessage()
func (*DeleteQueueRequest) ProtoReflect ¶
func (x *DeleteQueueRequest) ProtoReflect() protoreflect.Message
func (*DeleteQueueRequest) Reset ¶
func (x *DeleteQueueRequest) Reset()
func (*DeleteQueueRequest) String ¶
func (x *DeleteQueueRequest) String() string
type DeleteQueueResponse ¶
type DeleteQueueResponse struct { Id *v1.IdRaw `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // contains filtered or unexported fields }
DeleteQueueResponse returns the (now invalid) queue id of what was just deleted.
func (*DeleteQueueResponse) Descriptor
deprecated
func (*DeleteQueueResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeleteQueueResponse.ProtoReflect.Descriptor instead.
func (*DeleteQueueResponse) GetId ¶
func (x *DeleteQueueResponse) GetId() *v1.IdRaw
func (*DeleteQueueResponse) ProtoMessage ¶
func (*DeleteQueueResponse) ProtoMessage()
func (*DeleteQueueResponse) ProtoReflect ¶
func (x *DeleteQueueResponse) ProtoReflect() protoreflect.Message
func (*DeleteQueueResponse) Reset ¶
func (x *DeleteQueueResponse) Reset()
func (*DeleteQueueResponse) String ¶
func (x *DeleteQueueResponse) String() string
type LengthRequest ¶
type LengthRequest struct { Id *v1.IdRaw `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // contains filtered or unexported fields }
Length requests and approximation of the number of elements in the queue
func (*LengthRequest) Descriptor
deprecated
func (*LengthRequest) Descriptor() ([]byte, []int)
Deprecated: Use LengthRequest.ProtoReflect.Descriptor instead.
func (*LengthRequest) GetId ¶
func (x *LengthRequest) GetId() *v1.IdRaw
func (*LengthRequest) ProtoMessage ¶
func (*LengthRequest) ProtoMessage()
func (*LengthRequest) ProtoReflect ¶
func (x *LengthRequest) ProtoReflect() protoreflect.Message
func (*LengthRequest) Reset ¶
func (x *LengthRequest) Reset()
func (*LengthRequest) String ¶
func (x *LengthRequest) String() string
type LengthResponse ¶
type LengthResponse struct { Id *v1.IdRaw `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` Length int64 `protobuf:"varint,2,opt,name=length,proto3" json:"length,omitempty"` // contains filtered or unexported fields }
LengthResponse returns the queue id identifying the queue we computed the length for.
func (*LengthResponse) Descriptor
deprecated
func (*LengthResponse) Descriptor() ([]byte, []int)
Deprecated: Use LengthResponse.ProtoReflect.Descriptor instead.
func (*LengthResponse) GetId ¶
func (x *LengthResponse) GetId() *v1.IdRaw
func (*LengthResponse) GetLength ¶
func (x *LengthResponse) GetLength() int64
func (*LengthResponse) ProtoMessage ¶
func (*LengthResponse) ProtoMessage()
func (*LengthResponse) ProtoReflect ¶
func (x *LengthResponse) ProtoReflect() protoreflect.Message
func (*LengthResponse) Reset ¶
func (x *LengthResponse) Reset()
func (*LengthResponse) String ¶
func (x *LengthResponse) String() string
type LocateRequest ¶
type LocateRequest struct { QueueName string `protobuf:"bytes,1,opt,name=queue_name,json=queueName,proto3" json:"queue_name,omitempty"` // contains filtered or unexported fields }
LocateRequest is request to access a given queue.
func (*LocateRequest) Descriptor
deprecated
func (*LocateRequest) Descriptor() ([]byte, []int)
Deprecated: Use LocateRequest.ProtoReflect.Descriptor instead.
func (*LocateRequest) GetQueueName ¶
func (x *LocateRequest) GetQueueName() string
func (*LocateRequest) ProtoMessage ¶
func (*LocateRequest) ProtoMessage()
func (*LocateRequest) ProtoReflect ¶
func (x *LocateRequest) ProtoReflect() protoreflect.Message
func (*LocateRequest) Reset ¶
func (x *LocateRequest) Reset()
func (*LocateRequest) String ¶
func (x *LocateRequest) String() string
type LocateResponse ¶
type LocateResponse struct { Id *v1.IdRaw `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // contains filtered or unexported fields }
LocateResponse returns the queue id corresponding to the name provided. It returns errors out of band.
func (*LocateResponse) Descriptor
deprecated
func (*LocateResponse) Descriptor() ([]byte, []int)
Deprecated: Use LocateResponse.ProtoReflect.Descriptor instead.
func (*LocateResponse) GetId ¶
func (x *LocateResponse) GetId() *v1.IdRaw
func (*LocateResponse) ProtoMessage ¶
func (*LocateResponse) ProtoMessage()
func (*LocateResponse) ProtoReflect ¶
func (x *LocateResponse) ProtoReflect() protoreflect.Message
func (*LocateResponse) Reset ¶
func (x *LocateResponse) Reset()
func (*LocateResponse) String ¶
func (x *LocateResponse) String() string
type MarkDoneRequest ¶
type MarkDoneRequest struct { Id *v1.IdRaw `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` Msg []*v1.IdRaw `protobuf:"bytes,2,rep,name=msg,proto3" json:"msg,omitempty"` // contains filtered or unexported fields }
MarkDone request indicates that the caller has finished processing each message in
func (*MarkDoneRequest) Descriptor
deprecated
func (*MarkDoneRequest) Descriptor() ([]byte, []int)
Deprecated: Use MarkDoneRequest.ProtoReflect.Descriptor instead.
func (*MarkDoneRequest) GetId ¶
func (x *MarkDoneRequest) GetId() *v1.IdRaw
func (*MarkDoneRequest) GetMsg ¶
func (x *MarkDoneRequest) GetMsg() []*v1.IdRaw
func (*MarkDoneRequest) ProtoMessage ¶
func (*MarkDoneRequest) ProtoMessage()
func (*MarkDoneRequest) ProtoReflect ¶
func (x *MarkDoneRequest) ProtoReflect() protoreflect.Message
func (*MarkDoneRequest) Reset ¶
func (x *MarkDoneRequest) Reset()
func (*MarkDoneRequest) String ¶
func (x *MarkDoneRequest) String() string
type MarkDoneResponse ¶
type MarkDoneResponse struct { Id *v1.IdRaw `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` Unmodified []*v1.IdRaw `protobuf:"bytes,2,rep,name=unmodified,proto3" json:"unmodified,omitempty"` // contains filtered or unexported fields }
MarkDone returns the list of unmodified (not marked done) messages remaining. In the normal case, this will be empty. If there was an error trying to mark items as done, it returns the error and puts the unmarked elements in the list unmodified
func (*MarkDoneResponse) Descriptor
deprecated
func (*MarkDoneResponse) Descriptor() ([]byte, []int)
Deprecated: Use MarkDoneResponse.ProtoReflect.Descriptor instead.
func (*MarkDoneResponse) GetId ¶
func (x *MarkDoneResponse) GetId() *v1.IdRaw
func (*MarkDoneResponse) GetUnmodified ¶
func (x *MarkDoneResponse) GetUnmodified() []*v1.IdRaw
func (*MarkDoneResponse) ProtoMessage ¶
func (*MarkDoneResponse) ProtoMessage()
func (*MarkDoneResponse) ProtoReflect ¶
func (x *MarkDoneResponse) ProtoReflect() protoreflect.Message
func (*MarkDoneResponse) Reset ¶
func (x *MarkDoneResponse) Reset()
func (*MarkDoneResponse) String ¶
func (x *MarkDoneResponse) String() string
type QueueErr ¶
type QueueErr int32
const ( QueueErr_NoError QueueErr = 0 // mandatory QueueErr_DispatchError QueueErr = 1 // mandatory QueueErr_UnmarshalError QueueErr = 2 //mandatory QueueErr_MarshalError QueueErr = 3 //mandatory // InvalidName means that the given queue name is a not a valid // identifier. Identifiers must contain only ascii alphanumeric characters // and the symbols ".", ",","_" and "-". The first letter of a queue name // must be an alphabetic character. QueueErr_InvalidName QueueErr = 4 // InternalError means that the queue's implementation (not the values) // passed to it) is the problem. This is roughly a 500 not a 401. // This is usually caused by a problem with the internal // database used to store the queue items. QueueErr_InternalError QueueErr = 5 // NoPayload is an error that means that an attempt was made to create // a message a nil payload. Payloads are mandatory and senders are optional. QueueErr_NoPayload QueueErr = 6 // NotFound means that the Queue name requested could not be found. // This the queue equivalent of 404. QueueErr_NotFound QueueErr = 7 // AlreadyExists means that the Queue name is already in use. QueueErr_AlreadyExists QueueErr = 8 // Unmarshal error means that we could not use the protobuf // unmarshal successfully for a payload or sender. QueueErr_UnmarshalFailed QueueErr = 9 )
func (QueueErr) Descriptor ¶
func (QueueErr) Descriptor() protoreflect.EnumDescriptor
func (QueueErr) EnumDescriptor
deprecated
func (QueueErr) Number ¶
func (x QueueErr) Number() protoreflect.EnumNumber
func (QueueErr) Type ¶
func (QueueErr) Type() protoreflect.EnumType
type QueueId ¶
func NewQueueId ¶
func NewQueueId() QueueId
func QueueIdEmptyValue ¶
func QueueIdEmptyValue() QueueId
func QueueIdFromPair ¶
FromPair is probably not something you want to use unless you are pulling values from external storage or files. If you pulling values from the network, use the Marshal() ad Unmarshal() functions to work with Ids. Absolutely no checking is done on the values provided, so much caution is advised.
func QueueIdZeroValue ¶
func QueueIdZeroValue() QueueId
func UnmarshalQueueId ¶
func UnmarshalQueueId(b *protosupport.IdRaw) QueueId
func (QueueId) IsEmptyValue ¶
func (QueueId) IsZeroOrEmptyValue ¶
func (QueueId) IsZeroValue ¶
func (QueueId) Marshal ¶
func (f QueueId) Marshal() *protosupport.IdRaw
type QueueMsg ¶
type QueueMsg struct { Id *v1.IdRaw `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` MsgId *v1.IdRaw `protobuf:"bytes,2,opt,name=msg_id,json=msgId,proto3" json:"msg_id,omitempty"` // ReceiveCount is an approximation of the number of times // this messages has been delivered before this delivery. ReceiveCount int32 `protobuf:"varint,3,opt,name=receive_count,json=receiveCount,proto3" json:"receive_count,omitempty"` // ReceiveTime is an approximation to the first time the message was received. // If the message has never been received before, this will be the zero value. Received *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=received,proto3" json:"received,omitempty"` // sender may be any type (or nil) at the discretion of sender Sender *anypb.Any `protobuf:"bytes,5,opt,name=sender,proto3" json:"sender,omitempty"` // when the message was sent Sent *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=sent,proto3" json:"sent,omitempty"` // payload must be a serialized protobuf object Payload *anypb.Any `protobuf:"bytes,7,opt,name=payload,proto3" json:"payload,omitempty"` // contains filtered or unexported fields }
QueueMsg represents an object returned by a call to Receive.
func (*QueueMsg) Descriptor
deprecated
func (*QueueMsg) GetPayload ¶
func (*QueueMsg) GetReceiveCount ¶
func (*QueueMsg) GetReceived ¶
func (x *QueueMsg) GetReceived() *timestamppb.Timestamp
func (*QueueMsg) GetSent ¶
func (x *QueueMsg) GetSent() *timestamppb.Timestamp
func (*QueueMsg) ProtoMessage ¶
func (*QueueMsg) ProtoMessage()
func (*QueueMsg) ProtoReflect ¶
func (x *QueueMsg) ProtoReflect() protoreflect.Message
type QueueMsgId ¶
type QueueMsgId id.IdRoot[DefQueueMsg]
func NewQueueMsgId ¶
func NewQueueMsgId() QueueMsgId
func QueueMsgIdEmptyValue ¶
func QueueMsgIdEmptyValue() QueueMsgId
func QueueMsgIdFromPair ¶
func QueueMsgIdFromPair(high, low uint64) QueueMsgId
FromPair is probably not something you want to use unless you are pulling values from external storage or files. If you pulling values from the network, use the Marshal() ad Unmarshal() functions to work with Ids. Absolutely no checking is done on the values provided, so much caution is advised.
func QueueMsgIdZeroValue ¶
func QueueMsgIdZeroValue() QueueMsgId
func UnmarshalQueueMsgId ¶
func UnmarshalQueueMsgId(b *protosupport.IdRaw) QueueMsgId
func (QueueMsgId) Equal ¶
func (f QueueMsgId) Equal(other QueueMsgId) bool
func (QueueMsgId) High ¶
func (f QueueMsgId) High() uint64
func (QueueMsgId) IsEmptyValue ¶
func (f QueueMsgId) IsEmptyValue() bool
func (QueueMsgId) IsZeroOrEmptyValue ¶
func (f QueueMsgId) IsZeroOrEmptyValue() bool
func (QueueMsgId) IsZeroValue ¶
func (f QueueMsgId) IsZeroValue() bool
func (QueueMsgId) Low ¶
func (f QueueMsgId) Low() uint64
func (QueueMsgId) Marshal ¶
func (f QueueMsgId) Marshal() *protosupport.IdRaw
func (QueueMsgId) Short ¶
func (f QueueMsgId) Short() string
func (QueueMsgId) String ¶
func (f QueueMsgId) String() string
type ReceiveRequest ¶
type ReceiveRequest struct { Id *v1.IdRaw `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // it is expected that you can process all received messages inside the time limit MessageLimit int32 `protobuf:"varint,2,opt,name=message_limit,json=messageLimit,proto3" json:"message_limit,omitempty"` // 1 is usually the right choice here // contains filtered or unexported fields }
Receive pulls the available messages from the queue and returns them. Note that if multiple copies of the caller exist, the caller must be prepared to receive the same message multiple times.
func (*ReceiveRequest) Descriptor
deprecated
func (*ReceiveRequest) Descriptor() ([]byte, []int)
Deprecated: Use ReceiveRequest.ProtoReflect.Descriptor instead.
func (*ReceiveRequest) GetId ¶
func (x *ReceiveRequest) GetId() *v1.IdRaw
func (*ReceiveRequest) GetMessageLimit ¶
func (x *ReceiveRequest) GetMessageLimit() int32
func (*ReceiveRequest) ProtoMessage ¶
func (*ReceiveRequest) ProtoMessage()
func (*ReceiveRequest) ProtoReflect ¶
func (x *ReceiveRequest) ProtoReflect() protoreflect.Message
func (*ReceiveRequest) Reset ¶
func (x *ReceiveRequest) Reset()
func (*ReceiveRequest) String ¶
func (x *ReceiveRequest) String() string
type ReceiveResponse ¶
type ReceiveResponse struct { Id *v1.IdRaw `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` Message []*QueueMsg `protobuf:"bytes,2,rep,name=message,proto3" json:"message,omitempty"` // contains filtered or unexported fields }
Receive response hands the caller a list of messages to process. If you need to return an error, do so out of band.
func (*ReceiveResponse) Descriptor
deprecated
func (*ReceiveResponse) Descriptor() ([]byte, []int)
Deprecated: Use ReceiveResponse.ProtoReflect.Descriptor instead.
func (*ReceiveResponse) GetId ¶
func (x *ReceiveResponse) GetId() *v1.IdRaw
func (*ReceiveResponse) GetMessage ¶
func (x *ReceiveResponse) GetMessage() []*QueueMsg
func (*ReceiveResponse) ProtoMessage ¶
func (*ReceiveResponse) ProtoMessage()
func (*ReceiveResponse) ProtoReflect ¶
func (x *ReceiveResponse) ProtoReflect() protoreflect.Message
func (*ReceiveResponse) Reset ¶
func (x *ReceiveResponse) Reset()
func (*ReceiveResponse) String ¶
func (x *ReceiveResponse) String() string
type RowId ¶
func RowIdEmptyValue ¶
func RowIdEmptyValue() RowId
func RowIdFromPair ¶
FromPair is probably not something you want to use unless you are pulling values from external storage or files. If you pulling values from the network, use the Marshal() ad Unmarshal() functions to work with Ids. Absolutely no checking is done on the values provided, so much caution is advised.
func RowIdZeroValue ¶
func RowIdZeroValue() RowId
func UnmarshalRowId ¶
func UnmarshalRowId(b *protosupport.IdRaw) RowId
func (RowId) IsEmptyValue ¶
func (RowId) IsZeroOrEmptyValue ¶
func (RowId) IsZeroValue ¶
func (RowId) Marshal ¶
func (f RowId) Marshal() *protosupport.IdRaw
type SendRequest ¶
type SendRequest struct { Id *v1.IdRaw `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` Msg []*QueueMsg `protobuf:"bytes,2,rep,name=msg,proto3" json:"msg,omitempty"` // contains filtered or unexported fields }
Send requests enqueues the queue messages provided.
func (*SendRequest) Descriptor
deprecated
func (*SendRequest) Descriptor() ([]byte, []int)
Deprecated: Use SendRequest.ProtoReflect.Descriptor instead.
func (*SendRequest) GetId ¶
func (x *SendRequest) GetId() *v1.IdRaw
func (*SendRequest) GetMsg ¶
func (x *SendRequest) GetMsg() []*QueueMsg
func (*SendRequest) ProtoMessage ¶
func (*SendRequest) ProtoMessage()
func (*SendRequest) ProtoReflect ¶
func (x *SendRequest) ProtoReflect() protoreflect.Message
func (*SendRequest) Reset ¶
func (x *SendRequest) Reset()
func (*SendRequest) String ¶
func (x *SendRequest) String() string
type SendResponse ¶
type SendResponse struct { Succeed []*v1.IdRaw `protobuf:"bytes,1,rep,name=succeed,proto3" json:"succeed,omitempty"` Fail []*QueueMsg `protobuf:"bytes,2,rep,name=fail,proto3" json:"fail,omitempty"` FailedOn *v1.IdRaw `protobuf:"bytes,3,opt,name=failed_on,json=failedOn,proto3" json:"failed_on,omitempty"` // contains filtered or unexported fields }
If the queue msg id is an error then we are using the error_detail_msg to return the value. Note that the message id you provide here will changed once we send you the success notification using your id.
func (*SendResponse) Descriptor
deprecated
func (*SendResponse) Descriptor() ([]byte, []int)
Deprecated: Use SendResponse.ProtoReflect.Descriptor instead.
func (*SendResponse) GetFail ¶
func (x *SendResponse) GetFail() []*QueueMsg
func (*SendResponse) GetFailedOn ¶
func (x *SendResponse) GetFailedOn() *v1.IdRaw
func (*SendResponse) GetSucceed ¶
func (x *SendResponse) GetSucceed() []*v1.IdRaw
func (*SendResponse) ProtoMessage ¶
func (*SendResponse) ProtoMessage()
func (*SendResponse) ProtoReflect ¶
func (x *SendResponse) ProtoReflect() protoreflect.Message
func (*SendResponse) Reset ¶
func (x *SendResponse) Reset()
func (*SendResponse) String ¶
func (x *SendResponse) String() string