MessageSender | @azure/service-bus

internal: Describes the MessageSender that will send messages to ServiceBus.

Hierarchy

LinkEntity
- MessageSender

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MessageSender(context: ClientEntityContext, retryOptions: RetryOptions): MessageSender

Overrides LinkEntity.constructor
- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/core/messageSender.ts:80
Creates a new MessageSender instance.

Parameters
- context: ClientEntityContext
  
  The client entity context.
- retryOptions: RetryOptions
Returns MessageSender

Properties

Protected _context

_context: ClientEntityContext

property: {ClientEntityContext} _context Provides relevant information about the amqp connection, cbs and $management sessions, token provider, sender and receivers.

Protected Optional _tokenRenewalTimer

_tokenRenewalTimer: NodeJS.Timer

property: {NodeJS.Timer} _tokenRenewalTimer The token renewal timer that keeps track of when the Client Entity is due for token renewal.

Protected Optional _tokenTimeout

_tokenTimeout: undefined | number

property: _tokenTimeout Indicates token timeout

address

address: string

property

{string} address The client entity address in one of the following forms:

Sender

"<queue-name>".
"<topic-name>".

Receiver

"<queue-name>".
"<topic-name>".

ManagementClient -"$management".

audience

audience: string

property

{string} audience The client entity token audience in one of the following forms:

Sender

"sb://<yournamespace>.servicebus.windows.net/<queue-name>"
"sb://<yournamespace>.servicebus.windows.net/<topic-name>"

Receiver

"sb://<yournamespace>.servicebus.windows.net/<queue-name>"
"sb://<yournamespace>.servicebus.windows.net/<topic-name>"

ManagementClient

"sb://<your-namespace>.servicebus.windows.net/<queue-name>/$management".
"sb://<your-namespace>.servicebus.windows.net/<topic-name>/$management".

isConnecting

isConnecting: boolean = false

property: {boolean} isConnecting Indicates whether the link is in the process of connecting (establishing) itself. Default value: false.

name

name: string

property: {string} id The unique name for the entity in the format: ${name of the entity}-${guid}.

openLock

openLock: string = `sender-${generate_uuid()}`

property: {string} openLock The unique lock name per connection that is used to acquire the lock for establishing a sender link by an entity on that connection.
readonly

Methods

Protected _closeLink

_closeLink(link?: AwaitableSender | Receiver): Promise<void>

Inherited from LinkEntity._closeLink
- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/core/linkEntity.ts:223
Closes the Sender|Receiver link and it's underlying session and also removes it from the internal map.

Parameters
- Optional link: AwaitableSender | Receiver
Returns Promise<void>

Protected _ensureTokenRenewal

_ensureTokenRenewal(): Promise<void>

Inherited from LinkEntity._ensureTokenRenewal
- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/core/linkEntity.ts:187
Ensures that the token is renewed within the predefined renewal margin.

Returns Promise<void>

Protected _negotiateClaim

_negotiateClaim(setTokenRenewal?: undefined | false | true): Promise<void>

Inherited from LinkEntity._negotiateClaim
- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/core/linkEntity.ts:111
Negotiates the cbs claim for the ClientEntity.

Parameters
- Optional setTokenRenewal: undefined | false | true
Returns Promise<void>

Promise

close

close(): Promise<void>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/core/messageSender.ts:559
Deletes the sender from the context. Clears the token renewal timer. Closes the sender link.

Returns Promise<void>

Promise

createBatch

createBatch(options?: CreateBatchOptions): Promise<ServiceBusMessageBatch>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/core/messageSender.ts:756
Parameters
- Optional options: CreateBatchOptions
Returns Promise<ServiceBusMessageBatch>

getMaxMessageSize

getMaxMessageSize(options?: { retryOptions?: RetryOptions }): Promise<number>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/core/messageSender.ts:729
Returns maximum message size on the AMQP sender link.

Options to configure the createBatch method on the Sender.
- maxSizeInBytes: The upper limit for the size of batch.
Example usage:
```
{
    retryOptions: { maxRetries: 5; timeoutInMs: 10 }
}
```
Parameters
- Default value options: { retryOptions?: RetryOptions } = {}
  - Optional retryOptions?: RetryOptions
Returns Promise<number>

isOpen

isOpen(): boolean

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/core/messageSender.ts:576
Determines whether the AMQP sender link is open. If open then returns true else returns false.

Returns boolean

boolean

onDetached

onDetached(senderError?: AmqpError | Error): Promise<void>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/core/messageSender.ts:473
Will reconnect the sender link if necessary.

Parameters
- Optional senderError: AmqpError | Error
Returns Promise<void>

Promise.

open

open(options?: AwaitableSenderOptions): Promise<void>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/core/messageSender.ts:395
Initializes the sender session on the connection.

Parameters
- Optional options: AwaitableSenderOptions
Returns Promise<void>

send

send(data: ServiceBusMessage, options?: OperationOptions): Promise<void>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/core/messageSender.ts:594
Sends the given message, with the given options on this link

Parameters
- data: ServiceBusMessage
  
  Message to send. Will be sent as UTF8-encoded JSON string.
- Optional options: OperationOptions
Returns Promise<void>

sendBatch

sendBatch(batchMessage: ServiceBusMessageBatch, options?: OperationOptions): Promise<void>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/core/messageSender.ts:773
Parameters
- batchMessage: ServiceBusMessageBatch
- Optional options: OperationOptions
Returns Promise<void>

sendMessages

sendMessages(inputMessages: ServiceBusMessage[], options?: OperationOptions): Promise<void>

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/core/messageSender.ts:642
Send a batch of Message to the ServiceBus in a single AMQP message. The "message_annotations", "application_properties" and "properties" of the first message will be set as that of the envelope (batch message).

Parameters
- inputMessages: ServiceBusMessage[]
  
  An array of Message objects to be sent in a Batch message.
- Optional options: OperationOptions
Returns Promise<void>

Static create

create(context: ClientEntityContext, retryOptions: RetryOptions): MessageSender

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/core/messageSender.ts:833
Creates a new sender to the specific ServiceBus entity, and optionally to a given partition if it is not present in the context or returns the one present in the context.

static

Parameters
- context: ClientEntityContext
- retryOptions: RetryOptions
Returns MessageSender

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

context: ClientEntityContext

retryOptions: RetryOptions

Returns MessageSender

Properties

Protected _context

Protected Optional _tokenRenewalTimer

Protected Optional _tokenTimeout

address

audience

isConnecting

name

openLock

Methods

Protected _closeLink

Parameters

Optional link: AwaitableSender | Receiver

Returns Promise<void>

Protected _ensureTokenRenewal

Returns Promise<void>

Protected _negotiateClaim

Parameters

Optional setTokenRenewal: undefined | false | true

Returns Promise<void>

close

Returns Promise<void>

createBatch

Parameters

Optional options: CreateBatchOptions

Returns Promise<ServiceBusMessageBatch>

getMaxMessageSize

Parameters

Default value options: { retryOptions?: RetryOptions } = {}

Optional retryOptions?: RetryOptions

Returns Promise<number>

isOpen

Returns boolean

onDetached

Parameters

Optional senderError: AmqpError | Error

Returns Promise<void>

open

Parameters

Optional options: AwaitableSenderOptions

Returns Promise<void>

send

Parameters

data: ServiceBusMessage

Optional options: OperationOptions

Returns Promise<void>

sendBatch

Parameters

batchMessage: ServiceBusMessageBatch

Optional options: OperationOptions

Returns Promise<void>

sendMessages

Parameters

inputMessages: ServiceBusMessage[]

Optional options: OperationOptions

Returns Promise<void>

Static create

Parameters

context: ClientEntityContext

retryOptions: RetryOptions

Returns MessageSender