MQContract.KubeMQ 1.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
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                

                    
                

            
#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

<a name='assembly'></a>

MQContract.KubeMQ

Contents

<a name='T-MQContract-KubeMQ-SDK-Grpc-AckAllQueueMessagesRequest'></a>

AckAllQueueMessagesRequest type

Namespace

MQContract.KubeMQ.SDK.Grpc

<a name='F-MQContract-KubeMQ-SDK-Grpc-AckAllQueueMessagesRequest-ChannelFieldNumber'></a>

ChannelFieldNumber constants

Summary

Field number for the "Channel" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-AckAllQueueMessagesRequest-ClientIDFieldNumber'></a>

ClientIDFieldNumber constants

Summary

Field number for the "ClientID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-AckAllQueueMessagesRequest-RequestIDFieldNumber'></a>

RequestIDFieldNumber constants

Summary

Field number for the "RequestID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-AckAllQueueMessagesRequest-WaitTimeSecondsFieldNumber'></a>

WaitTimeSecondsFieldNumber constants

Summary

Field number for the "WaitTimeSeconds" field.

<a name='T-MQContract-KubeMQ-SDK-Grpc-AckAllQueueMessagesResponse'></a>

AckAllQueueMessagesResponse type

Namespace

MQContract.KubeMQ.SDK.Grpc

<a name='F-MQContract-KubeMQ-SDK-Grpc-AckAllQueueMessagesResponse-AffectedMessagesFieldNumber'></a>

AffectedMessagesFieldNumber constants

Summary

Field number for the "AffectedMessages" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-AckAllQueueMessagesResponse-ErrorFieldNumber'></a>

ErrorFieldNumber constants

Summary

Field number for the "Error" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-AckAllQueueMessagesResponse-IsErrorFieldNumber'></a>

IsErrorFieldNumber constants

Summary

Field number for the "IsError" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-AckAllQueueMessagesResponse-RequestIDFieldNumber'></a>

RequestIDFieldNumber constants

Summary

Field number for the "RequestID" field.

<a name='T-MQContract-KubeMQ-ClientDisposedException'></a>

ClientDisposedException type

Namespace

MQContract.KubeMQ

Summary

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

<a name='T-MQContract-KubeMQ-Connection'></a>

Connection type

Namespace

MQContract.KubeMQ

Summary

This is the MessageServiceConnection implementation for using KubeMQ

<a name='M-MQContract-KubeMQ-Connection-#ctor-MQContract-KubeMQ-ConnectionOptions-'></a>

#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

<a name='P-MQContract-KubeMQ-Connection-DefaultTimout'></a>

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

<a name='P-MQContract-KubeMQ-Connection-MaxMessageBodySize'></a>

MaxMessageBodySize property

Summary

The maximum message body size allowed

<a name='M-MQContract-KubeMQ-Connection-Dispose-System-Boolean-'></a>

Dispose(disposing) method

Summary

Called to dispose of the resources used

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

<a name='M-MQContract-KubeMQ-Connection-Dispose'></a>

Dispose() method

Summary

Called to dispose of the resources used

Parameters

This method has no parameters.

<a name='M-MQContract-KubeMQ-Connection-PingAsync'></a>

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

<a name='M-MQContract-KubeMQ-Connection-PublishAsync-MQContract-Messages-ServiceMessage,MQContract-Interfaces-Service-IServiceChannelOptions,System-Threading-CancellationToken-'></a>

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

<a name='M-MQContract-KubeMQ-Connection-QueryAsync-MQContract-Messages-ServiceMessage,System-TimeSpan,MQContract-Interfaces-Service-IServiceChannelOptions,System-Threading-CancellationToken-'></a>

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

<a name='M-MQContract-KubeMQ-Connection-SubscribeAsync-System-Action{MQContract-Messages-RecievedServiceMessage},System-Action{System-Exception},System-String,System-String,MQContract-Interfaces-Service-IServiceChannelOptions,System-Threading-CancellationToken-'></a>

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

<a name='M-MQContract-KubeMQ-Connection-SubscribeQueryAsync-System-Func{MQContract-Messages-RecievedServiceMessage,System-Threading-Tasks-Task{MQContract-Messages-ServiceMessage}},System-Action{System-Exception},System-String,System-String,MQContract-Interfaces-Service-IServiceChannelOptions,System-Threading-CancellationToken-'></a>

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

<a name='T-MQContract-KubeMQ-ConnectionOptions'></a>

ConnectionOptions type

Namespace

MQContract.KubeMQ

Summary

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

<a name='P-MQContract-KubeMQ-ConnectionOptions-Address'></a>

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

<a name='P-MQContract-KubeMQ-ConnectionOptions-AuthToken'></a>

AuthToken property

Summary

The authentication token to use when connecting to the KubeMQ server

<a name='P-MQContract-KubeMQ-ConnectionOptions-ClientId'></a>

ClientId property

Summary

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

<a name='P-MQContract-KubeMQ-ConnectionOptions-DefaultRPCTimeout'></a>

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.

<a name='P-MQContract-KubeMQ-ConnectionOptions-Logger'></a>

Logger property

Summary

Logging instance to use in underlying service layer

<a name='P-MQContract-KubeMQ-ConnectionOptions-MaxBodySize'></a>

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.

<a name='P-MQContract-KubeMQ-ConnectionOptions-ReconnectInterval'></a>

ReconnectInterval property

Summary

Milliseconds to wait in between attempted reconnects to the KubeMQ server

<a name='P-MQContract-KubeMQ-ConnectionOptions-SSLCertificate'></a>

SSLCertificate property

Summary

The SSL Certificat to use when connecting to the KubeMQ server

<a name='P-MQContract-KubeMQ-ConnectionOptions-SSLKey'></a>

SSLKey property

Summary

The SSL Key to use when connecting to the KubeMQ server

<a name='P-MQContract-KubeMQ-ConnectionOptions-SSLRootCertificate'></a>

SSLRootCertificate property

Summary

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

<a name='T-MQContract-KubeMQ-SDK-Grpc-Event'></a>

Event type

Namespace

MQContract.KubeMQ.SDK.Grpc

<a name='F-MQContract-KubeMQ-SDK-Grpc-Event-BodyFieldNumber'></a>

BodyFieldNumber constants

Summary

Field number for the "Body" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Event-ChannelFieldNumber'></a>

ChannelFieldNumber constants

Summary

Field number for the "Channel" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Event-ClientIDFieldNumber'></a>

ClientIDFieldNumber constants

Summary

Field number for the "ClientID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Event-EventIDFieldNumber'></a>

EventIDFieldNumber constants

Summary

Field number for the "EventID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Event-MetadataFieldNumber'></a>

MetadataFieldNumber constants

Summary

Field number for the "Metadata" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Event-StoreFieldNumber'></a>

StoreFieldNumber constants

Summary

Field number for the "Store" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Event-TagsFieldNumber'></a>

TagsFieldNumber constants

Summary

Field number for the "Tags" field.

<a name='T-MQContract-KubeMQ-SDK-Grpc-EventReceive'></a>

EventReceive type

Namespace

MQContract.KubeMQ.SDK.Grpc

<a name='F-MQContract-KubeMQ-SDK-Grpc-EventReceive-BodyFieldNumber'></a>

BodyFieldNumber constants

Summary

Field number for the "Body" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-EventReceive-ChannelFieldNumber'></a>

ChannelFieldNumber constants

Summary

Field number for the "Channel" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-EventReceive-EventIDFieldNumber'></a>

EventIDFieldNumber constants

Summary

Field number for the "EventID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-EventReceive-MetadataFieldNumber'></a>

MetadataFieldNumber constants

Summary

Field number for the "Metadata" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-EventReceive-SequenceFieldNumber'></a>

SequenceFieldNumber constants

Summary

Field number for the "Sequence" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-EventReceive-TagsFieldNumber'></a>

TagsFieldNumber constants

Summary

Field number for the "Tags" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-EventReceive-TimestampFieldNumber'></a>

TimestampFieldNumber constants

Summary

Field number for the "Timestamp" field.

<a name='T-MQContract-KubeMQ-Interfaces-IKubeMQPingResult'></a>

IKubeMQPingResult type

Namespace

MQContract.KubeMQ.Interfaces

Summary

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

<a name='P-MQContract-KubeMQ-Interfaces-IKubeMQPingResult-Host'></a>

Host property

Summary

The host name for the server pinged

<a name='P-MQContract-KubeMQ-Interfaces-IKubeMQPingResult-ResponseTime'></a>

ResponseTime property

Summary

How long it took the server to respond to the request

<a name='P-MQContract-KubeMQ-Interfaces-IKubeMQPingResult-ServerStartTime'></a>

ServerStartTime property

Summary

The Server Start Time of the host that was pinged

<a name='P-MQContract-KubeMQ-Interfaces-IKubeMQPingResult-ServerUpTime'></a>

ServerUpTime property

Summary

The Server Up Time of the host that was pinged

<a name='P-MQContract-KubeMQ-Interfaces-IKubeMQPingResult-Version'></a>

Version property

Summary

The current version of KubeMQ running on it

<a name='T-MQContract-KubeMQ-SDK-Grpc-KubemqReflection'></a>

KubemqReflection type

Namespace

MQContract.KubeMQ.SDK.Grpc

Summary

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

<a name='P-MQContract-KubeMQ-SDK-Grpc-KubemqReflection-Descriptor'></a>

Descriptor property

Summary

File descriptor for SDK/Grpc/kubemq.proto

<a name='T-MQContract-KubeMQ-Options-StoredEventsSubscriptionOptions-MessageReadStyle'></a>

MessageReadStyle type

Namespace

MQContract.KubeMQ.Options.StoredEventsSubscriptionOptions

Summary

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

<a name='F-MQContract-KubeMQ-Options-StoredEventsSubscriptionOptions-MessageReadStyle-StartAtSequence'></a>

StartAtSequence constants

Summary

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

<a name='F-MQContract-KubeMQ-Options-StoredEventsSubscriptionOptions-MessageReadStyle-StartAtTime'></a>

StartAtTime constants

Summary

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

<a name='F-MQContract-KubeMQ-Options-StoredEventsSubscriptionOptions-MessageReadStyle-StartAtTimeDelta'></a>

StartAtTimeDelta constants

Summary

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

<a name='F-MQContract-KubeMQ-Options-StoredEventsSubscriptionOptions-MessageReadStyle-StartFromFirst'></a>

StartFromFirst constants

Summary

Start at the beginning

<a name='F-MQContract-KubeMQ-Options-StoredEventsSubscriptionOptions-MessageReadStyle-StartFromLast'></a>

StartFromLast constants

Summary

Start at the last message

<a name='F-MQContract-KubeMQ-Options-StoredEventsSubscriptionOptions-MessageReadStyle-StartNewOnly'></a>

StartNewOnly constants

Summary

Start from the new ones (unread ones) only

<a name='T-MQContract-KubeMQ-MessageResponseTransmissionException'></a>

MessageResponseTransmissionException type

Namespace

MQContract.KubeMQ

Summary

Thrown when an error occurs sending and rpc response

<a name='T-MQContract-KubeMQ-SDK-Grpc-PingResult'></a>

PingResult type

Namespace

MQContract.KubeMQ.SDK.Grpc

<a name='F-MQContract-KubeMQ-SDK-Grpc-PingResult-HostFieldNumber'></a>

HostFieldNumber constants

Summary

Field number for the "Host" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-PingResult-ServerStartTimeFieldNumber'></a>

ServerStartTimeFieldNumber constants

Summary

Field number for the "ServerStartTime" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-PingResult-ServerUpTimeSecondsFieldNumber'></a>

ServerUpTimeSecondsFieldNumber constants

Summary

Field number for the "ServerUpTimeSeconds" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-PingResult-VersionFieldNumber'></a>

VersionFieldNumber constants

Summary

Field number for the "Version" field.

<a name='T-MQContract-KubeMQ-SDK-Grpc-PollRequest'></a>

PollRequest type

Namespace

MQContract.KubeMQ.SDK.Grpc

<a name='F-MQContract-KubeMQ-SDK-Grpc-PollRequest-AckRangeFieldNumber'></a>

AckRangeFieldNumber constants

Summary

Field number for the "AckRange" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-PollRequest-AutoAckFieldNumber'></a>

AutoAckFieldNumber constants

Summary

Field number for the "AutoAck" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-PollRequest-ChannelFieldNumber'></a>

ChannelFieldNumber constants

Summary

Field number for the "Channel" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-PollRequest-ClientIDFieldNumber'></a>

ClientIDFieldNumber constants

Summary

Field number for the "ClientID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-PollRequest-HeadersFieldNumber'></a>

HeadersFieldNumber constants

Summary

Field number for the "Headers" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-PollRequest-RefTransactionIdFieldNumber'></a>

RefTransactionIdFieldNumber constants

Summary

Field number for the "RefTransactionId" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-PollRequest-RequestIDFieldNumber'></a>

RequestIDFieldNumber constants

Summary

Field number for the "RequestID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-PollRequest-StreamRequestTypeDataFieldNumber'></a>

StreamRequestTypeDataFieldNumber constants

Summary

Field number for the "StreamRequestTypeData" field.

<a name='T-MQContract-KubeMQ-SDK-Grpc-PollResponse'></a>

PollResponse type

Namespace

MQContract.KubeMQ.SDK.Grpc

<a name='F-MQContract-KubeMQ-SDK-Grpc-PollResponse-ErrorFieldNumber'></a>

ErrorFieldNumber constants

Summary

Field number for the "Error" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-PollResponse-HeadersFieldNumber'></a>

HeadersFieldNumber constants

Summary

Field number for the "Headers" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-PollResponse-IsErrorFieldNumber'></a>

IsErrorFieldNumber constants

Summary

Field number for the "IsError" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-PollResponse-MessagesFieldNumber'></a>

MessagesFieldNumber constants

Summary

Field number for the "Messages" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-PollResponse-RefRequestIdFieldNumber'></a>

RefRequestIdFieldNumber constants

Summary

Field number for the "RefRequestId" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-PollResponse-StreamRequestTypeDataFieldNumber'></a>

StreamRequestTypeDataFieldNumber constants

Summary

Field number for the "StreamRequestTypeData" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-PollResponse-TransactionIdFieldNumber'></a>

TransactionIdFieldNumber constants

Summary

Field number for the "TransactionId" field.

<a name='T-MQContract-KubeMQ-Options-PublishChannelOptions'></a>

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

<a name='M-MQContract-KubeMQ-Options-PublishChannelOptions-#ctor-System-Boolean-'></a>

#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

<a name='P-MQContract-KubeMQ-Options-PublishChannelOptions-Stored'></a>

Stored property

Summary

Indicates if the publish should be using storage

<a name='T-MQContract-KubeMQ-SDK-Grpc-QueueMessage'></a>

QueueMessage type

Namespace

MQContract.KubeMQ.SDK.Grpc

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessage-AttributesFieldNumber'></a>

AttributesFieldNumber constants

Summary

Field number for the "Attributes" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessage-BodyFieldNumber'></a>

BodyFieldNumber constants

Summary

Field number for the "Body" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessage-ChannelFieldNumber'></a>

ChannelFieldNumber constants

Summary

Field number for the "Channel" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessage-ClientIDFieldNumber'></a>

ClientIDFieldNumber constants

Summary

Field number for the "ClientID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessage-MessageIDFieldNumber'></a>

MessageIDFieldNumber constants

Summary

Field number for the "MessageID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessage-MetadataFieldNumber'></a>

MetadataFieldNumber constants

Summary

Field number for the "Metadata" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessage-PolicyFieldNumber'></a>

PolicyFieldNumber constants

Summary

Field number for the "Policy" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessage-TagsFieldNumber'></a>

TagsFieldNumber constants

Summary

Field number for the "Tags" field.

<a name='T-MQContract-KubeMQ-SDK-Grpc-QueueMessageAttributes'></a>

QueueMessageAttributes type

Namespace

MQContract.KubeMQ.SDK.Grpc

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessageAttributes-DelayedToFieldNumber'></a>

DelayedToFieldNumber constants

Summary

Field number for the "DelayedTo" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessageAttributes-ExpirationAtFieldNumber'></a>

ExpirationAtFieldNumber constants

Summary

Field number for the "ExpirationAt" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessageAttributes-MD5OfBodyFieldNumber'></a>

MD5OfBodyFieldNumber constants

Summary

Field number for the "MD5OfBody" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessageAttributes-ReRoutedFieldNumber'></a>

ReRoutedFieldNumber constants

Summary

Field number for the "ReRouted" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessageAttributes-ReRoutedFromQueueFieldNumber'></a>

ReRoutedFromQueueFieldNumber constants

Summary

Field number for the "ReRoutedFromQueue" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessageAttributes-ReceiveCountFieldNumber'></a>

ReceiveCountFieldNumber constants

Summary

Field number for the "ReceiveCount" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessageAttributes-SequenceFieldNumber'></a>

SequenceFieldNumber constants

Summary

Field number for the "Sequence" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessageAttributes-TimestampFieldNumber'></a>

TimestampFieldNumber constants

Summary

Field number for the "Timestamp" field.

<a name='T-MQContract-KubeMQ-SDK-Grpc-QueueMessagePolicy'></a>

QueueMessagePolicy type

Namespace

MQContract.KubeMQ.SDK.Grpc

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessagePolicy-DelaySecondsFieldNumber'></a>

DelaySecondsFieldNumber constants

Summary

Field number for the "DelaySeconds" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessagePolicy-ExpirationSecondsFieldNumber'></a>

ExpirationSecondsFieldNumber constants

Summary

Field number for the "ExpirationSeconds" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessagePolicy-MaxReceiveCountFieldNumber'></a>

MaxReceiveCountFieldNumber constants

Summary

Field number for the "MaxReceiveCount" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessagePolicy-MaxReceiveQueueFieldNumber'></a>

MaxReceiveQueueFieldNumber constants

Summary

Field number for the "MaxReceiveQueue" field.

<a name='T-MQContract-KubeMQ-SDK-Grpc-QueueMessagesBatchRequest'></a>

QueueMessagesBatchRequest type

Namespace

MQContract.KubeMQ.SDK.Grpc

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessagesBatchRequest-BatchIDFieldNumber'></a>

BatchIDFieldNumber constants

Summary

Field number for the "BatchID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessagesBatchRequest-MessagesFieldNumber'></a>

MessagesFieldNumber constants

Summary

Field number for the "Messages" field.

<a name='T-MQContract-KubeMQ-SDK-Grpc-QueueMessagesBatchResponse'></a>

QueueMessagesBatchResponse type

Namespace

MQContract.KubeMQ.SDK.Grpc

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessagesBatchResponse-BatchIDFieldNumber'></a>

BatchIDFieldNumber constants

Summary

Field number for the "BatchID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessagesBatchResponse-HaveErrorsFieldNumber'></a>

HaveErrorsFieldNumber constants

Summary

Field number for the "HaveErrors" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-QueueMessagesBatchResponse-ResultsFieldNumber'></a>

ResultsFieldNumber constants

Summary

Field number for the "Results" field.

<a name='T-MQContract-KubeMQ-SDK-Grpc-ReceiveQueueMessagesRequest'></a>

ReceiveQueueMessagesRequest type

Namespace

MQContract.KubeMQ.SDK.Grpc

<a name='F-MQContract-KubeMQ-SDK-Grpc-ReceiveQueueMessagesRequest-ChannelFieldNumber'></a>

ChannelFieldNumber constants

Summary

Field number for the "Channel" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-ReceiveQueueMessagesRequest-ClientIDFieldNumber'></a>

ClientIDFieldNumber constants

Summary

Field number for the "ClientID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-ReceiveQueueMessagesRequest-IsPeakFieldNumber'></a>

IsPeakFieldNumber constants

Summary

Field number for the "IsPeak" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-ReceiveQueueMessagesRequest-MaxNumberOfMessagesFieldNumber'></a>

MaxNumberOfMessagesFieldNumber constants

Summary

Field number for the "MaxNumberOfMessages" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-ReceiveQueueMessagesRequest-RequestIDFieldNumber'></a>

RequestIDFieldNumber constants

Summary

Field number for the "RequestID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-ReceiveQueueMessagesRequest-WaitTimeSecondsFieldNumber'></a>

WaitTimeSecondsFieldNumber constants

Summary

Field number for the "WaitTimeSeconds" field.

<a name='T-MQContract-KubeMQ-SDK-Grpc-ReceiveQueueMessagesResponse'></a>

ReceiveQueueMessagesResponse type

Namespace

MQContract.KubeMQ.SDK.Grpc

<a name='F-MQContract-KubeMQ-SDK-Grpc-ReceiveQueueMessagesResponse-ErrorFieldNumber'></a>

ErrorFieldNumber constants

Summary

Field number for the "Error" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-ReceiveQueueMessagesResponse-IsErrorFieldNumber'></a>

IsErrorFieldNumber constants

Summary

Field number for the "IsError" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-ReceiveQueueMessagesResponse-IsPeakFieldNumber'></a>

IsPeakFieldNumber constants

Summary

Field number for the "IsPeak" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-ReceiveQueueMessagesResponse-MessagesExpiredFieldNumber'></a>

MessagesExpiredFieldNumber constants

Summary

Field number for the "MessagesExpired" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-ReceiveQueueMessagesResponse-MessagesFieldNumber'></a>

MessagesFieldNumber constants

Summary

Field number for the "Messages" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-ReceiveQueueMessagesResponse-MessagesReceivedFieldNumber'></a>

MessagesReceivedFieldNumber constants

Summary

Field number for the "MessagesReceived" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-ReceiveQueueMessagesResponse-RequestIDFieldNumber'></a>

RequestIDFieldNumber constants

Summary

Field number for the "RequestID" field.

<a name='T-MQContract-KubeMQ-SDK-Grpc-Request'></a>

Request type

Namespace

MQContract.KubeMQ.SDK.Grpc

<a name='F-MQContract-KubeMQ-SDK-Grpc-Request-BodyFieldNumber'></a>

BodyFieldNumber constants

Summary

Field number for the "Body" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Request-CacheKeyFieldNumber'></a>

CacheKeyFieldNumber constants

Summary

Field number for the "CacheKey" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Request-CacheTTLFieldNumber'></a>

CacheTTLFieldNumber constants

Summary

Field number for the "CacheTTL" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Request-ChannelFieldNumber'></a>

ChannelFieldNumber constants

Summary

Field number for the "Channel" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Request-ClientIDFieldNumber'></a>

ClientIDFieldNumber constants

Summary

Field number for the "ClientID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Request-MetadataFieldNumber'></a>

MetadataFieldNumber constants

Summary

Field number for the "Metadata" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Request-ReplyChannelFieldNumber'></a>

ReplyChannelFieldNumber constants

Summary

Field number for the "ReplyChannel" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Request-RequestIDFieldNumber'></a>

RequestIDFieldNumber constants

Summary

Field number for the "RequestID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Request-RequestTypeDataFieldNumber'></a>

RequestTypeDataFieldNumber constants

Summary

Field number for the "RequestTypeData" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Request-SpanFieldNumber'></a>

SpanFieldNumber constants

Summary

Field number for the "Span" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Request-TagsFieldNumber'></a>

TagsFieldNumber constants

Summary

Field number for the "Tags" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Request-TimeoutFieldNumber'></a>

TimeoutFieldNumber constants

Summary

Field number for the "Timeout" field.

<a name='T-MQContract-KubeMQ-SDK-Grpc-Response'></a>

Response type

Namespace

MQContract.KubeMQ.SDK.Grpc

<a name='F-MQContract-KubeMQ-SDK-Grpc-Response-BodyFieldNumber'></a>

BodyFieldNumber constants

Summary

Field number for the "Body" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Response-CacheHitFieldNumber'></a>

CacheHitFieldNumber constants

Summary

Field number for the "CacheHit" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Response-ClientIDFieldNumber'></a>

ClientIDFieldNumber constants

Summary

Field number for the "ClientID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Response-ErrorFieldNumber'></a>

ErrorFieldNumber constants

Summary

Field number for the "Error" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Response-ExecutedFieldNumber'></a>

ExecutedFieldNumber constants

Summary

Field number for the "Executed" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Response-MetadataFieldNumber'></a>

MetadataFieldNumber constants

Summary

Field number for the "Metadata" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Response-ReplyChannelFieldNumber'></a>

ReplyChannelFieldNumber constants

Summary

Field number for the "ReplyChannel" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Response-RequestIDFieldNumber'></a>

RequestIDFieldNumber constants

Summary

Field number for the "RequestID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Response-SpanFieldNumber'></a>

SpanFieldNumber constants

Summary

Field number for the "Span" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Response-TagsFieldNumber'></a>

TagsFieldNumber constants

Summary

Field number for the "Tags" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Response-TimestampFieldNumber'></a>

TimestampFieldNumber constants

Summary

Field number for the "Timestamp" field.

<a name='T-MQContract-KubeMQ-SDK-Grpc-Result'></a>

Result type

Namespace

MQContract.KubeMQ.SDK.Grpc

<a name='F-MQContract-KubeMQ-SDK-Grpc-Result-ErrorFieldNumber'></a>

ErrorFieldNumber constants

Summary

Field number for the "Error" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Result-EventIDFieldNumber'></a>

EventIDFieldNumber constants

Summary

Field number for the "EventID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Result-SentFieldNumber'></a>

SentFieldNumber constants

Summary

Field number for the "Sent" field.

<a name='T-MQContract-KubeMQ-SDK-Grpc-SendQueueMessageResult'></a>

SendQueueMessageResult type

Namespace

MQContract.KubeMQ.SDK.Grpc

<a name='F-MQContract-KubeMQ-SDK-Grpc-SendQueueMessageResult-DelayedToFieldNumber'></a>

DelayedToFieldNumber constants

Summary

Field number for the "DelayedTo" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-SendQueueMessageResult-ErrorFieldNumber'></a>

ErrorFieldNumber constants

Summary

Field number for the "Error" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-SendQueueMessageResult-ExpirationAtFieldNumber'></a>

ExpirationAtFieldNumber constants

Summary

Field number for the "ExpirationAt" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-SendQueueMessageResult-IsErrorFieldNumber'></a>

IsErrorFieldNumber constants

Summary

Field number for the "IsError" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-SendQueueMessageResult-MessageIDFieldNumber'></a>

MessageIDFieldNumber constants

Summary

Field number for the "MessageID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-SendQueueMessageResult-SentAtFieldNumber'></a>

SentAtFieldNumber constants

Summary

Field number for the "SentAt" field.

<a name='T-MQContract-KubeMQ-Options-StoredEventsSubscriptionOptions'></a>

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

<a name='M-MQContract-KubeMQ-Options-StoredEventsSubscriptionOptions-#ctor-MQContract-KubeMQ-Options-StoredEventsSubscriptionOptions-MessageReadStyle,System-Int64-'></a>

#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

<a name='P-MQContract-KubeMQ-Options-StoredEventsSubscriptionOptions-ReadOffset'></a>

ReadOffset property

Summary

The read offset to use

<a name='P-MQContract-KubeMQ-Options-StoredEventsSubscriptionOptions-ReadStyle'></a>

ReadStyle property

Summary

The read style to use

<a name='T-MQContract-KubeMQ-SDK-Grpc-StreamQueueMessagesRequest'></a>

StreamQueueMessagesRequest type

Namespace

MQContract.KubeMQ.SDK.Grpc

<a name='F-MQContract-KubeMQ-SDK-Grpc-StreamQueueMessagesRequest-ChannelFieldNumber'></a>

ChannelFieldNumber constants

Summary

Field number for the "Channel" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-StreamQueueMessagesRequest-ClientIDFieldNumber'></a>

ClientIDFieldNumber constants

Summary

Field number for the "ClientID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-StreamQueueMessagesRequest-ModifiedMessageFieldNumber'></a>

ModifiedMessageFieldNumber constants

Summary

Field number for the "ModifiedMessage" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-StreamQueueMessagesRequest-RefSequenceFieldNumber'></a>

RefSequenceFieldNumber constants

Summary

Field number for the "RefSequence" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-StreamQueueMessagesRequest-RequestIDFieldNumber'></a>

RequestIDFieldNumber constants

Summary

Field number for the "RequestID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-StreamQueueMessagesRequest-StreamRequestTypeDataFieldNumber'></a>

StreamRequestTypeDataFieldNumber constants

Summary

Field number for the "StreamRequestTypeData" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-StreamQueueMessagesRequest-VisibilitySecondsFieldNumber'></a>

VisibilitySecondsFieldNumber constants

Summary

Field number for the "VisibilitySeconds" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-StreamQueueMessagesRequest-WaitTimeSecondsFieldNumber'></a>

WaitTimeSecondsFieldNumber constants

Summary

Field number for the "WaitTimeSeconds" field.

<a name='T-MQContract-KubeMQ-SDK-Grpc-StreamQueueMessagesResponse'></a>

StreamQueueMessagesResponse type

Namespace

MQContract.KubeMQ.SDK.Grpc

<a name='F-MQContract-KubeMQ-SDK-Grpc-StreamQueueMessagesResponse-ErrorFieldNumber'></a>

ErrorFieldNumber constants

Summary

Field number for the "Error" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-StreamQueueMessagesResponse-IsErrorFieldNumber'></a>

IsErrorFieldNumber constants

Summary

Field number for the "IsError" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-StreamQueueMessagesResponse-MessageFieldNumber'></a>

MessageFieldNumber constants

Summary

Field number for the "Message" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-StreamQueueMessagesResponse-RequestIDFieldNumber'></a>

RequestIDFieldNumber constants

Summary

Field number for the "RequestID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-StreamQueueMessagesResponse-StreamRequestTypeDataFieldNumber'></a>

StreamRequestTypeDataFieldNumber constants

Summary

Field number for the "StreamRequestTypeData" field.

<a name='T-MQContract-KubeMQ-SDK-Grpc-Subscribe'></a>

Subscribe type

Namespace

MQContract.KubeMQ.SDK.Grpc

<a name='F-MQContract-KubeMQ-SDK-Grpc-Subscribe-ChannelFieldNumber'></a>

ChannelFieldNumber constants

Summary

Field number for the "Channel" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Subscribe-ClientIDFieldNumber'></a>

ClientIDFieldNumber constants

Summary

Field number for the "ClientID" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Subscribe-EventsStoreTypeDataFieldNumber'></a>

EventsStoreTypeDataFieldNumber constants

Summary

Field number for the "EventsStoreTypeData" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Subscribe-EventsStoreTypeValueFieldNumber'></a>

EventsStoreTypeValueFieldNumber constants

Summary

Field number for the "EventsStoreTypeValue" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Subscribe-GroupFieldNumber'></a>

GroupFieldNumber constants

Summary

Field number for the "Group" field.

<a name='F-MQContract-KubeMQ-SDK-Grpc-Subscribe-SubscribeTypeDataFieldNumber'></a>

SubscribeTypeDataFieldNumber constants

Summary

Field number for the "SubscribeTypeData" field.

<a name='T-MQContract-KubeMQ-SDK-Grpc-Request-Types'></a>

Types type

Namespace

MQContract.KubeMQ.SDK.Grpc.Request

Summary

Container for nested types declared in the Request message type.

<a name='T-MQContract-KubeMQ-SDK-Grpc-Subscribe-Types'></a>

Types type

Namespace

MQContract.KubeMQ.SDK.Grpc.Subscribe

Summary

Container for nested types declared in the Subscribe message type.

<a name='T-MQContract-KubeMQ-UnableToConnectException'></a>

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.

<a name='T-MQContract-KubeMQ-SDK-Grpc-kubemq'></a>

kubemq type

Namespace

MQContract.KubeMQ.SDK.Grpc

<a name='P-MQContract-KubeMQ-SDK-Grpc-kubemq-Descriptor'></a>

Descriptor property

Summary

Service descriptor

<a name='T-MQContract-KubeMQ-SDK-Grpc-kubemq-kubemqClient'></a>

kubemqClient type

Namespace

MQContract.KubeMQ.SDK.Grpc.kubemq

Summary

Client for kubemq

<a name='M-MQContract-KubeMQ-SDK-Grpc-kubemq-kubemqClient-#ctor-Grpc-Core-ChannelBase-'></a>

#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.

<a name='M-MQContract-KubeMQ-SDK-Grpc-kubemq-kubemqClient-#ctor-Grpc-Core-CallInvoker-'></a>

#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.

<a name='M-MQContract-KubeMQ-SDK-Grpc-kubemq-kubemqClient-#ctor'></a>

#ctor() constructor

Summary

Protected parameterless constructor to allow creation of test doubles.

Parameters

This constructor has no parameters.

<a name='M-MQContract-KubeMQ-SDK-Grpc-kubemq-kubemqClient-#ctor-Grpc-Core-ClientBase-ClientBaseConfiguration-'></a>

#ctor(configuration) constructor

Summary

Protected constructor to allow creation of configured clients.

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

<a name='M-MQContract-KubeMQ-SDK-Grpc-kubemq-kubemqClient-NewInstance-Grpc-Core-ClientBase-ClientBaseConfiguration-'></a>

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.

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 67 10/3/2024
1.0.0 88 8/8/2024