MQContract.KubeMQ 1.0.0

There is a newer version of this package available.
See the version list below for details.

dotnet add package MQContract.KubeMQ --version 1.0.0

NuGet\Install-Package MQContract.KubeMQ -Version 1.0.0

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="MQContract.KubeMQ" Version="1.0.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add MQContract.KubeMQ --version 1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: MQContract.KubeMQ, 1.0.0"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install MQContract.KubeMQ as a Cake Addin
#addin nuget:?package=MQContract.KubeMQ&version=1.0.0

// Install MQContract.KubeMQ as a Cake Tool
#tool nuget:?package=MQContract.KubeMQ&version=1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

MQContract.KubeMQ

AckAllQueueMessagesRequest
- ChannelFieldNumber
- ClientIDFieldNumber
- RequestIDFieldNumber
- WaitTimeSecondsFieldNumber
AckAllQueueMessagesResponse
- AffectedMessagesFieldNumber
- ErrorFieldNumber
- IsErrorFieldNumber
- RequestIDFieldNumber
ClientDisposedException
Connection
- #ctor(options)
- DefaultTimout
- MaxMessageBodySize
- Dispose(disposing)
- Dispose()
- PingAsync()
- PublishAsync(message,options,cancellationToken)
- QueryAsync(message,timeout,options,cancellationToken)
- SubscribeAsync(messageRecieved,errorRecieved,channel,group,options,cancellationToken)
- SubscribeQueryAsync(messageRecieved,errorRecieved,channel,group,options,cancellationToken)
ConnectionOptions
- Address
- AuthToken
- ClientId
- DefaultRPCTimeout
- Logger
- MaxBodySize
- ReconnectInterval
- SSLCertificate
- SSLKey
- SSLRootCertificate
Event
- BodyFieldNumber
- ChannelFieldNumber
- ClientIDFieldNumber
- EventIDFieldNumber
- MetadataFieldNumber
- StoreFieldNumber
- TagsFieldNumber
EventReceive
- BodyFieldNumber
- ChannelFieldNumber
- EventIDFieldNumber
- MetadataFieldNumber
- SequenceFieldNumber
- TagsFieldNumber
- TimestampFieldNumber
IKubeMQPingResult
- Host
- ResponseTime
- ServerStartTime
- ServerUpTime
- Version
KubemqReflection
- Descriptor
MessageReadStyle
- StartAtSequence
- StartAtTime
- StartAtTimeDelta
- StartFromFirst
- StartFromLast
- StartNewOnly
MessageResponseTransmissionException
PingResult
- HostFieldNumber
- ServerStartTimeFieldNumber
- ServerUpTimeSecondsFieldNumber
- VersionFieldNumber
PollRequest
- AckRangeFieldNumber
- AutoAckFieldNumber
- ChannelFieldNumber
- ClientIDFieldNumber
- HeadersFieldNumber
- RefTransactionIdFieldNumber
- RequestIDFieldNumber
- StreamRequestTypeDataFieldNumber
PollResponse
- ErrorFieldNumber
- HeadersFieldNumber
- IsErrorFieldNumber
- MessagesFieldNumber
- RefRequestIdFieldNumber
- StreamRequestTypeDataFieldNumber
- TransactionIdFieldNumber
PublishChannelOptions
- #ctor(Stored)
- Stored
QueueMessage
- AttributesFieldNumber
- BodyFieldNumber
- ChannelFieldNumber
- ClientIDFieldNumber
- MessageIDFieldNumber
- MetadataFieldNumber
- PolicyFieldNumber
- TagsFieldNumber
QueueMessageAttributes
- DelayedToFieldNumber
- ExpirationAtFieldNumber
- MD5OfBodyFieldNumber
- ReRoutedFieldNumber
- ReRoutedFromQueueFieldNumber
- ReceiveCountFieldNumber
- SequenceFieldNumber
- TimestampFieldNumber
QueueMessagePolicy
- DelaySecondsFieldNumber
- ExpirationSecondsFieldNumber
- MaxReceiveCountFieldNumber
- MaxReceiveQueueFieldNumber
QueueMessagesBatchRequest
- BatchIDFieldNumber
- MessagesFieldNumber
QueueMessagesBatchResponse
- BatchIDFieldNumber
- HaveErrorsFieldNumber
- ResultsFieldNumber
ReceiveQueueMessagesRequest
- ChannelFieldNumber
- ClientIDFieldNumber
- IsPeakFieldNumber
- MaxNumberOfMessagesFieldNumber
- RequestIDFieldNumber
- WaitTimeSecondsFieldNumber
ReceiveQueueMessagesResponse
- ErrorFieldNumber
- IsErrorFieldNumber
- IsPeakFieldNumber
- MessagesExpiredFieldNumber
- MessagesFieldNumber
- MessagesReceivedFieldNumber
- RequestIDFieldNumber
Request
- BodyFieldNumber
- CacheKeyFieldNumber
- CacheTTLFieldNumber
- ChannelFieldNumber
- ClientIDFieldNumber
- MetadataFieldNumber
- ReplyChannelFieldNumber
- RequestIDFieldNumber
- RequestTypeDataFieldNumber
- SpanFieldNumber
- TagsFieldNumber
- TimeoutFieldNumber
Response
- BodyFieldNumber
- CacheHitFieldNumber
- ClientIDFieldNumber
- ErrorFieldNumber
- ExecutedFieldNumber
- MetadataFieldNumber
- ReplyChannelFieldNumber
- RequestIDFieldNumber
- SpanFieldNumber
- TagsFieldNumber
- TimestampFieldNumber
Result
- ErrorFieldNumber
- EventIDFieldNumber
- SentFieldNumber
SendQueueMessageResult
- DelayedToFieldNumber
- ErrorFieldNumber
- ExpirationAtFieldNumber
- IsErrorFieldNumber
- MessageIDFieldNumber
- SentAtFieldNumber
StoredEventsSubscriptionOptions
- #ctor(ReadStyle,ReadOffset)
- ReadOffset
- ReadStyle
StreamQueueMessagesRequest
- ChannelFieldNumber
- ClientIDFieldNumber
- ModifiedMessageFieldNumber
- RefSequenceFieldNumber
- RequestIDFieldNumber
- StreamRequestTypeDataFieldNumber
- VisibilitySecondsFieldNumber
- WaitTimeSecondsFieldNumber
StreamQueueMessagesResponse
- ErrorFieldNumber
- IsErrorFieldNumber
- MessageFieldNumber
- RequestIDFieldNumber
- StreamRequestTypeDataFieldNumber
Subscribe
- ChannelFieldNumber
- ClientIDFieldNumber
- EventsStoreTypeDataFieldNumber
- EventsStoreTypeValueFieldNumber
- GroupFieldNumber
- SubscribeTypeDataFieldNumber
Types
Types
UnableToConnectException
kubemq
- Descriptor
kubemqClient
- #ctor(channel)
- #ctor(callInvoker)
- #ctor()
- #ctor(configuration)
- NewInstance()

AckAllQueueMessagesRequest `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

ChannelFieldNumber `constants`

Summary

Field number for the "Channel" field.

ClientIDFieldNumber `constants`

Summary

Field number for the "ClientID" field.

RequestIDFieldNumber `constants`

Summary

Field number for the "RequestID" field.

WaitTimeSecondsFieldNumber `constants`

Summary

Field number for the "WaitTimeSeconds" field.

AckAllQueueMessagesResponse `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

AffectedMessagesFieldNumber `constants`

Summary

Field number for the "AffectedMessages" field.

ErrorFieldNumber `constants`

Summary

Field number for the "Error" field.

IsErrorFieldNumber `constants`

Summary

Field number for the "IsError" field.

RequestIDFieldNumber `constants`

Summary

Field number for the "RequestID" field.

ClientDisposedException `type`

Namespace

MQContract.KubeMQ

Summary

Thrown when a call is made to an underlying KubeClient after the client has been disposed

Connection `type`

Namespace

MQContract.KubeMQ

Summary

This is the MessageServiceConnection implementation for using KubeMQ

#ctor(options) `constructor`

Summary

Primary constructor to create an instance using the supplied configuration options

Parameters

Name	Type	Description
options	MQContract.KubeMQ.ConnectionOptions	The configuration options to use

Exceptions

Name	Description
MQContract.KubeMQ.UnableToConnectException	Thrown when the initial attempt to connect fails

DefaultTimout `property`

Summary

The default timeout to use for RPC calls when not specified by the class or in the call. DEFAULT:30 seconds if not specified inside the connection options

MaxMessageBodySize `property`

Summary

The maximum message body size allowed

Dispose(disposing) `method`

Summary

Called to dispose of the resources used

Parameters

Name	Type	Description
disposing	System.Boolean	Indicates if it is disposing

Dispose() `method`

Summary

Called to dispose of the resources used

Parameters

This method has no parameters.

PingAsync() `method`

Summary

Called to ping the KubeMQ service

Returns

The Ping result, specically a PingResponse instance

Parameters

This method has no parameters.

Exceptions

Name	Description
MQContract.KubeMQ.UnableToConnectException	Thrown when the Ping fails

PublishAsync(message,options,cancellationToken) `method`

Summary

Called to publish a message into the KubeMQ server

Returns

Transmition result identifying if it worked or not

Parameters

Name	Type	Description
message	MQContract.Messages.ServiceMessage	The service message being sent
options	MQContract.Interfaces.Service.IServiceChannelOptions	The service channel options, if desired, specifically the PublishChannelOptions which is used to access the storage capabilities of KubeMQ
cancellationToken	System.Threading.CancellationToken	A cancellation token

Exceptions

Name	Description
MQContract.InvalidChannelOptionsTypeException	Thrown when an attempt to pass an options object that is not of the type PublishChannelOptions

QueryAsync(message,timeout,options,cancellationToken) `method`

Summary

Called to publish a query into the KubeMQ server

Returns

The resulting response

Parameters

Name	Type	Description
message	MQContract.Messages.ServiceMessage	The service message being sent
timeout	System.TimeSpan	The timeout supplied for the query to response
options	MQContract.Interfaces.Service.IServiceChannelOptions	Should be null here as there is no Service Channel Options implemented for this call
cancellationToken	System.Threading.CancellationToken	A cancellation token

Exceptions

Name	Description
MQContract.NoChannelOptionsAvailableException	Thrown if options was supplied because there are no implemented options for this call
MQContract.KubeMQ.NullResponseException	Thrown when the response from KubeMQ is null
MQContract.KubeMQ.RPCErrorException	Thrown when there is an RPC exception from the KubeMQ server

SubscribeAsync(messageRecieved,errorRecieved,channel,group,options,cancellationToken) `method`

Summary

Called to create a subscription to the underlying KubeMQ server

Returns

A subscription instance

Parameters

Name	Type	Description
messageRecieved	System.Action{MQContract.Messages.RecievedServiceMessage}	Callback for when a message is recieved
errorRecieved	System.Action{System.Exception}	Callback for when an error occurs
channel	System.String	The name of the channel to bind to
group	System.String	The group to subscribe as part of
options	MQContract.Interfaces.Service.IServiceChannelOptions	The service channel options, if desired, specifically the StoredEventsSubscriptionOptions which is used to access stored event streams
cancellationToken	System.Threading.CancellationToken	A cancellation token

Exceptions

Name	Description
MQContract.InvalidChannelOptionsTypeException	Thrown when options is not null and is not an instance of the type StoredEventsSubscriptionOptions

SubscribeQueryAsync(messageRecieved,errorRecieved,channel,group,options,cancellationToken) `method`

Summary

Called to create a subscription for queries to the underlying KubeMQ server

Returns

A subscription instance

Parameters

Name	Type	Description
messageRecieved	System.Func{MQContract.Messages.RecievedServiceMessage,System.Threading.Tasks.Task{MQContract.Messages.ServiceMessage}}	Callback for when a query is recieved
errorRecieved	System.Action{System.Exception}	Callback for when an error occurs
channel	System.String	The name of the channel to bind to
group	System.String	The group to subscribe as part of
options	MQContract.Interfaces.Service.IServiceChannelOptions	Should be null here as there is no Service Channel Options implemented for this call
cancellationToken	System.Threading.CancellationToken	A cancellation token

Exceptions

Name	Description
MQContract.NoChannelOptionsAvailableException	Thrown if options was supplied because there are no implemented options for this call

ConnectionOptions `type`

Namespace

MQContract.KubeMQ

Summary

Houses the Connection Settings to use to connect to the particular instance of KubeMQ

Address `property`

Summary

The address and port to connection to. This can be the dns name or an ip address. Use the format {ip/name}:{portnumber}. Typically KubeMQ is configured to listen on port 50000

AuthToken `property`

Summary

The authentication token to use when connecting to the KubeMQ server

ClientId `property`

Summary

The Unique Identification to be used when connecting to the KubeMQ server

DefaultRPCTimeout `property`

Summary

Timeout in milliseconds to use as a default for RPC calls if there is an override desired. Otherwise the default is 5000.

Logger `property`

Summary

Logging instance to use in underlying service layer

MaxBodySize `property`

Summary

The maximum body size in bytes configured on the KubeMQ server, default is 100MB. If the encoded message exceeds the size, it will zip it in an attempt to transmit the message. If it still fails in size, an exception will be thrown.

ReconnectInterval `property`

Summary

Milliseconds to wait in between attempted reconnects to the KubeMQ server

SSLCertificate `property`

Summary

The SSL Certificat to use when connecting to the KubeMQ server

SSLKey `property`

Summary

The SSL Key to use when connecting to the KubeMQ server

SSLRootCertificate `property`

Summary

The SSL Root certificate to use when connecting to the KubeMQ server

Event `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

BodyFieldNumber `constants`

Summary

Field number for the "Body" field.

ChannelFieldNumber `constants`

Summary

Field number for the "Channel" field.

ClientIDFieldNumber `constants`

Summary

Field number for the "ClientID" field.

EventIDFieldNumber `constants`

Summary

Field number for the "EventID" field.

MetadataFieldNumber `constants`

Summary

Field number for the "Metadata" field.

StoreFieldNumber `constants`

Summary

Field number for the "Store" field.

TagsFieldNumber `constants`

Summary

Field number for the "Tags" field.

EventReceive `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

BodyFieldNumber `constants`

Summary

Field number for the "Body" field.

ChannelFieldNumber `constants`

Summary

Field number for the "Channel" field.

EventIDFieldNumber `constants`

Summary

Field number for the "EventID" field.

MetadataFieldNumber `constants`

Summary

Field number for the "Metadata" field.

SequenceFieldNumber `constants`

Summary

Field number for the "Sequence" field.

TagsFieldNumber `constants`

Summary

Field number for the "Tags" field.

TimestampFieldNumber `constants`

Summary

Field number for the "Timestamp" field.

IKubeMQPingResult `type`

Namespace

MQContract.KubeMQ.Interfaces

Summary

The definition for a PingResponse coming from KubeMQ that has a couple of extra properties available

Host `property`

Summary

The host name for the server pinged

ResponseTime `property`

Summary

How long it took the server to respond to the request

ServerStartTime `property`

Summary

The Server Start Time of the host that was pinged

ServerUpTime `property`

Summary

The Server Up Time of the host that was pinged

Version `property`

Summary

The current version of KubeMQ running on it

KubemqReflection `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

Summary

Holder for reflection information generated from SDK/Grpc/kubemq.proto

Descriptor `property`

Summary

File descriptor for SDK/Grpc/kubemq.proto

MessageReadStyle `type`

Namespace

MQContract.KubeMQ.Options.StoredEventsSubscriptionOptions

Summary

These are the different read styles to use when subscribing to a stored Event PubSub

StartAtSequence `constants`

Summary

Start at message number X (this value is specified when creating the listener)

StartAtTime `constants`

Summary

Start at time X (this value is specified when creating the listener)

StartAtTimeDelta `constants`

Summary

Start at Time Delte X (this value is specified when creating the listener)

StartFromFirst `constants`

Summary

Start at the beginning

StartFromLast `constants`

Summary

Start at the last message

StartNewOnly `constants`

Summary

Start from the new ones (unread ones) only

MessageResponseTransmissionException `type`

Namespace

MQContract.KubeMQ

Summary

Thrown when an error occurs sending and rpc response

PingResult `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

HostFieldNumber `constants`

Summary

Field number for the "Host" field.

ServerStartTimeFieldNumber `constants`

Summary

Field number for the "ServerStartTime" field.

ServerUpTimeSecondsFieldNumber `constants`

Summary

Field number for the "ServerUpTimeSeconds" field.

VersionFieldNumber `constants`

Summary

Field number for the "Version" field.

PollRequest `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

AckRangeFieldNumber `constants`

Summary

Field number for the "AckRange" field.

AutoAckFieldNumber `constants`

Summary

Field number for the "AutoAck" field.

ChannelFieldNumber `constants`

Summary

Field number for the "Channel" field.

ClientIDFieldNumber `constants`

Summary

Field number for the "ClientID" field.

HeadersFieldNumber `constants`

Summary

Field number for the "Headers" field.

RefTransactionIdFieldNumber `constants`

Summary

Field number for the "RefTransactionId" field.

RequestIDFieldNumber `constants`

Summary

Field number for the "RequestID" field.

StreamRequestTypeDataFieldNumber `constants`

Summary

Field number for the "StreamRequestTypeData" field.

PollResponse `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

ErrorFieldNumber `constants`

Summary

Field number for the "Error" field.

HeadersFieldNumber `constants`

Summary

Field number for the "Headers" field.

IsErrorFieldNumber `constants`

Summary

Field number for the "IsError" field.

MessagesFieldNumber `constants`

Summary

Field number for the "Messages" field.

RefRequestIdFieldNumber `constants`

Summary

Field number for the "RefRequestId" field.

StreamRequestTypeDataFieldNumber `constants`

Summary

Field number for the "StreamRequestTypeData" field.

TransactionIdFieldNumber `constants`

Summary

Field number for the "TransactionId" field.

PublishChannelOptions `type`

Namespace

MQContract.KubeMQ.Options

Summary

Houses the Publish Channel options used when calling the Publish command

Parameters

Name	Type	Description
Stored	T:MQContract.KubeMQ.Options.PublishChannelOptions	Indicates if the publish should be using storage

#ctor(Stored) `constructor`

Summary

Houses the Publish Channel options used when calling the Publish command

Parameters

Name	Type	Description
Stored	System.Boolean	Indicates if the publish should be using storage

Stored `property`

Summary

Indicates if the publish should be using storage

QueueMessage `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

AttributesFieldNumber `constants`

Summary

Field number for the "Attributes" field.

BodyFieldNumber `constants`

Summary

Field number for the "Body" field.

ChannelFieldNumber `constants`

Summary

Field number for the "Channel" field.

ClientIDFieldNumber `constants`

Summary

Field number for the "ClientID" field.

MessageIDFieldNumber `constants`

Summary

Field number for the "MessageID" field.

MetadataFieldNumber `constants`

Summary

Field number for the "Metadata" field.

PolicyFieldNumber `constants`

Summary

Field number for the "Policy" field.

TagsFieldNumber `constants`

Summary

Field number for the "Tags" field.

QueueMessageAttributes `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

DelayedToFieldNumber `constants`

Summary

Field number for the "DelayedTo" field.

ExpirationAtFieldNumber `constants`

Summary

Field number for the "ExpirationAt" field.

MD5OfBodyFieldNumber `constants`

Summary

Field number for the "MD5OfBody" field.

ReRoutedFieldNumber `constants`

Summary

Field number for the "ReRouted" field.

ReRoutedFromQueueFieldNumber `constants`

Summary

Field number for the "ReRoutedFromQueue" field.

ReceiveCountFieldNumber `constants`

Summary

Field number for the "ReceiveCount" field.

SequenceFieldNumber `constants`

Summary

Field number for the "Sequence" field.

TimestampFieldNumber `constants`

Summary

Field number for the "Timestamp" field.

QueueMessagePolicy `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

DelaySecondsFieldNumber `constants`

Summary

Field number for the "DelaySeconds" field.

ExpirationSecondsFieldNumber `constants`

Summary

Field number for the "ExpirationSeconds" field.

MaxReceiveCountFieldNumber `constants`

Summary

Field number for the "MaxReceiveCount" field.

MaxReceiveQueueFieldNumber `constants`

Summary

Field number for the "MaxReceiveQueue" field.

QueueMessagesBatchRequest `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

BatchIDFieldNumber `constants`

Summary

Field number for the "BatchID" field.

MessagesFieldNumber `constants`

Summary

Field number for the "Messages" field.

QueueMessagesBatchResponse `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

BatchIDFieldNumber `constants`

Summary

Field number for the "BatchID" field.

HaveErrorsFieldNumber `constants`

Summary

Field number for the "HaveErrors" field.

ResultsFieldNumber `constants`

Summary

Field number for the "Results" field.

ReceiveQueueMessagesRequest `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

ChannelFieldNumber `constants`

Summary

Field number for the "Channel" field.

ClientIDFieldNumber `constants`

Summary

Field number for the "ClientID" field.

IsPeakFieldNumber `constants`

Summary

Field number for the "IsPeak" field.

MaxNumberOfMessagesFieldNumber `constants`

Summary

Field number for the "MaxNumberOfMessages" field.

RequestIDFieldNumber `constants`

Summary

Field number for the "RequestID" field.

WaitTimeSecondsFieldNumber `constants`

Summary

Field number for the "WaitTimeSeconds" field.

ReceiveQueueMessagesResponse `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

ErrorFieldNumber `constants`

Summary

Field number for the "Error" field.

IsErrorFieldNumber `constants`

Summary

Field number for the "IsError" field.

IsPeakFieldNumber `constants`

Summary

Field number for the "IsPeak" field.

MessagesExpiredFieldNumber `constants`

Summary

Field number for the "MessagesExpired" field.

MessagesFieldNumber `constants`

Summary

Field number for the "Messages" field.

MessagesReceivedFieldNumber `constants`

Summary

Field number for the "MessagesReceived" field.

RequestIDFieldNumber `constants`

Summary

Field number for the "RequestID" field.

Request `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

BodyFieldNumber `constants`

Summary

Field number for the "Body" field.

CacheKeyFieldNumber `constants`

Summary

Field number for the "CacheKey" field.

CacheTTLFieldNumber `constants`

Summary

Field number for the "CacheTTL" field.

ChannelFieldNumber `constants`

Summary

Field number for the "Channel" field.

ClientIDFieldNumber `constants`

Summary

Field number for the "ClientID" field.

MetadataFieldNumber `constants`

Summary

Field number for the "Metadata" field.

ReplyChannelFieldNumber `constants`

Summary

Field number for the "ReplyChannel" field.

RequestIDFieldNumber `constants`

Summary

Field number for the "RequestID" field.

RequestTypeDataFieldNumber `constants`

Summary

Field number for the "RequestTypeData" field.

SpanFieldNumber `constants`

Summary

Field number for the "Span" field.

TagsFieldNumber `constants`

Summary

Field number for the "Tags" field.

TimeoutFieldNumber `constants`

Summary

Field number for the "Timeout" field.

Response `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

BodyFieldNumber `constants`

Summary

Field number for the "Body" field.

CacheHitFieldNumber `constants`

Summary

Field number for the "CacheHit" field.

ClientIDFieldNumber `constants`

Summary

Field number for the "ClientID" field.

ErrorFieldNumber `constants`

Summary

Field number for the "Error" field.

ExecutedFieldNumber `constants`

Summary

Field number for the "Executed" field.

MetadataFieldNumber `constants`

Summary

Field number for the "Metadata" field.

ReplyChannelFieldNumber `constants`

Summary

Field number for the "ReplyChannel" field.

RequestIDFieldNumber `constants`

Summary

Field number for the "RequestID" field.

SpanFieldNumber `constants`

Summary

Field number for the "Span" field.

TagsFieldNumber `constants`

Summary

Field number for the "Tags" field.

TimestampFieldNumber `constants`

Summary

Field number for the "Timestamp" field.

Result `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

ErrorFieldNumber `constants`

Summary

Field number for the "Error" field.

EventIDFieldNumber `constants`

Summary

Field number for the "EventID" field.

SentFieldNumber `constants`

Summary

Field number for the "Sent" field.

SendQueueMessageResult `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

DelayedToFieldNumber `constants`

Summary

Field number for the "DelayedTo" field.

ErrorFieldNumber `constants`

Summary

Field number for the "Error" field.

ExpirationAtFieldNumber `constants`

Summary

Field number for the "ExpirationAt" field.

IsErrorFieldNumber `constants`

Summary

Field number for the "IsError" field.

MessageIDFieldNumber `constants`

Summary

Field number for the "MessageID" field.

SentAtFieldNumber `constants`

Summary

Field number for the "SentAt" field.

StoredEventsSubscriptionOptions `type`

Namespace

MQContract.KubeMQ.Options

Summary

Houses the configuration for a subscription going to a stored message channel

Parameters

Name	Type	Description
ReadStyle	T:MQContract.KubeMQ.Options.StoredEventsSubscriptionOptions	The read style to use

#ctor(ReadStyle,ReadOffset) `constructor`

Summary

Houses the configuration for a subscription going to a stored message channel

Parameters

Name	Type	Description
ReadStyle	MQContract.KubeMQ.Options.StoredEventsSubscriptionOptions.MessageReadStyle	The read style to use
ReadOffset	System.Int64	The read offset to use

ReadOffset `property`

Summary

The read offset to use

ReadStyle `property`

Summary

The read style to use

StreamQueueMessagesRequest `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

ChannelFieldNumber `constants`

Summary

Field number for the "Channel" field.

ClientIDFieldNumber `constants`

Summary

Field number for the "ClientID" field.

ModifiedMessageFieldNumber `constants`

Summary

Field number for the "ModifiedMessage" field.

RefSequenceFieldNumber `constants`

Summary

Field number for the "RefSequence" field.

RequestIDFieldNumber `constants`

Summary

Field number for the "RequestID" field.

StreamRequestTypeDataFieldNumber `constants`

Summary

Field number for the "StreamRequestTypeData" field.

VisibilitySecondsFieldNumber `constants`

Summary

Field number for the "VisibilitySeconds" field.

WaitTimeSecondsFieldNumber `constants`

Summary

Field number for the "WaitTimeSeconds" field.

StreamQueueMessagesResponse `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

ErrorFieldNumber `constants`

Summary

Field number for the "Error" field.

IsErrorFieldNumber `constants`

Summary

Field number for the "IsError" field.

MessageFieldNumber `constants`

Summary

Field number for the "Message" field.

RequestIDFieldNumber `constants`

Summary

Field number for the "RequestID" field.

StreamRequestTypeDataFieldNumber `constants`

Summary

Field number for the "StreamRequestTypeData" field.

Subscribe `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

ChannelFieldNumber `constants`

Summary

Field number for the "Channel" field.

ClientIDFieldNumber `constants`

Summary

Field number for the "ClientID" field.

EventsStoreTypeDataFieldNumber `constants`

Summary

Field number for the "EventsStoreTypeData" field.

EventsStoreTypeValueFieldNumber `constants`

Summary

Field number for the "EventsStoreTypeValue" field.

GroupFieldNumber `constants`

Summary

Field number for the "Group" field.

SubscribeTypeDataFieldNumber `constants`

Summary

Field number for the "SubscribeTypeData" field.

Types `type`

Namespace

MQContract.KubeMQ.SDK.Grpc.Request

Summary

Container for nested types declared in the Request message type.

Types `type`

Namespace

MQContract.KubeMQ.SDK.Grpc.Subscribe

Summary

Container for nested types declared in the Subscribe message type.

UnableToConnectException `type`

Namespace

MQContract.KubeMQ

Summary

Thrown when an error occurs attempting to connect to the KubeMQ server.
Specifically this will be thrown when the Ping that is executed on each initial connection fails.

kubemq `type`

Namespace

MQContract.KubeMQ.SDK.Grpc

Descriptor `property`

Summary

Service descriptor

kubemqClient `type`

Namespace

MQContract.KubeMQ.SDK.Grpc.kubemq

Summary

Client for kubemq

#ctor(channel) `constructor`

Summary

Creates a new client for kubemq

Parameters

Name	Type	Description
channel	Grpc.Core.ChannelBase	The channel to use to make remote calls.

#ctor(callInvoker) `constructor`

Summary

Creates a new client for kubemq that uses a custom CallInvoker.

Parameters

Name	Type	Description
callInvoker	Grpc.Core.CallInvoker	The callInvoker to use to make remote calls.

#ctor() `constructor`

Summary

Protected parameterless constructor to allow creation of test doubles.

Parameters

This constructor has no parameters.

#ctor(configuration) `constructor`

Summary

Protected constructor to allow creation of configured clients.

Parameters

Name	Type	Description
configuration	Grpc.Core.ClientBase.ClientBaseConfiguration	The client configuration.

NewInstance() `method`

Summary

Creates a new instance of client from given ClientBaseConfiguration.

Parameters

This method has no parameters.

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- Google.Protobuf (>= 3.27.2)
- Grpc.Net.Client (>= 2.64.0)
- MQContract.Abstractions (>= 1.0.0)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
1.1.0	96	10/3/2024
1.0.0	104	8/8/2024

MQContract.KubeMQ 1.0.0

MQContract.KubeMQ

Contents

AckAllQueueMessagesRequest type

Namespace

ChannelFieldNumber constants

Summary

ClientIDFieldNumber constants

Summary

RequestIDFieldNumber constants

Summary

WaitTimeSecondsFieldNumber constants

Summary

AckAllQueueMessagesResponse type

Namespace

AffectedMessagesFieldNumber constants

Summary

ErrorFieldNumber constants

Summary

IsErrorFieldNumber constants

Summary

RequestIDFieldNumber constants

Summary

ClientDisposedException type

Namespace

Summary

Connection type

Namespace

Summary

#ctor(options) constructor

Summary

Parameters

Exceptions

DefaultTimout property

Summary

MaxMessageBodySize property

Summary

Dispose(disposing) method

Summary

Parameters

Dispose() method

Summary

Parameters

PingAsync() method

Summary

Returns

Parameters

Exceptions

PublishAsync(message,options,cancellationToken) method

Summary

Returns

Parameters

Exceptions

QueryAsync(message,timeout,options,cancellationToken) method

Summary

Returns

Parameters

Exceptions

SubscribeAsync(messageRecieved,errorRecieved,channel,group,options,cancellationToken) method

Summary

Returns

Parameters

Exceptions

SubscribeQueryAsync(messageRecieved,errorRecieved,channel,group,options,cancellationToken) method

Summary

Returns

Parameters

Exceptions

ConnectionOptions type

Namespace

Summary

Address property

Summary

AuthToken property

Summary

ClientId property

Summary

DefaultRPCTimeout property

Summary

Logger property

AckAllQueueMessagesRequest `type`

ChannelFieldNumber `constants`

ClientIDFieldNumber `constants`

RequestIDFieldNumber `constants`

WaitTimeSecondsFieldNumber `constants`

AckAllQueueMessagesResponse `type`

AffectedMessagesFieldNumber `constants`

ErrorFieldNumber `constants`

IsErrorFieldNumber `constants`

RequestIDFieldNumber `constants`

ClientDisposedException `type`

Connection `type`

#ctor(options) `constructor`

DefaultTimout `property`

MaxMessageBodySize `property`

Dispose(disposing) `method`

Dispose() `method`

PingAsync() `method`

PublishAsync(message,options,cancellationToken) `method`

QueryAsync(message,timeout,options,cancellationToken) `method`

SubscribeAsync(messageRecieved,errorRecieved,channel,group,options,cancellationToken) `method`

SubscribeQueryAsync(messageRecieved,errorRecieved,channel,group,options,cancellationToken) `method`

ConnectionOptions `type`

Address `property`

AuthToken `property`

ClientId `property`

DefaultRPCTimeout `property`

Logger `property`

MaxBodySize `property`

ReconnectInterval `property`

SSLCertificate `property`

SSLKey `property`

SSLRootCertificate `property`

Event `type`

BodyFieldNumber `constants`

ChannelFieldNumber `constants`

ClientIDFieldNumber `constants`

EventIDFieldNumber `constants`

MetadataFieldNumber `constants`

StoreFieldNumber `constants`

TagsFieldNumber `constants`

EventReceive `type`

BodyFieldNumber `constants`

ChannelFieldNumber `constants`

EventIDFieldNumber `constants`

MetadataFieldNumber `constants`

SequenceFieldNumber `constants`

TagsFieldNumber `constants`

TimestampFieldNumber `constants`

IKubeMQPingResult `type`

Host `property`

ResponseTime `property`

ServerStartTime `property`

ServerUpTime `property`

Version `property`

KubemqReflection `type`

Descriptor `property`

MessageReadStyle `type`

StartAtSequence `constants`

StartAtTime `constants`

StartAtTimeDelta `constants`