AMQPChannel overview
Added in v0.1.0
Table of contents
Layers
layer
Signature
export declare const layer: (
options?: AMQPChannelOptions
) => Layer.Layer<AMQPChannel, AMQPError.AMQPChannelError | AMQPError.AMQPConnectionError, AMQPConnection.AMQPConnection>
Added in v0.1.0
constructors
make
Signature
export declare const make: (
options?: AMQPChannelOptions
) => Effect.Effect<
AMQPChannel,
AMQPError.AMQPChannelError | AMQPError.AMQPConnectionError,
Scope.Scope | AMQPConnection.AMQPConnection
>
Added in v0.1.0
models
AMQPChannel (interface)
Signature
export interface AMQPChannel {
readonly [TypeId]: TypeId
readonly connection: AMQPConnection.AMQPConnection
readonly consume: (
queueName: string,
options?: { readonly prefetch?: number }
) => Effect.Effect<Stream.Stream<AMQPConsumeMessage.AMQPConsumeMessage, AMQPError.AMQPChannelError>>
readonly ack: (...parameters: Parameters<Channel["ack"]>) => Effect.Effect<void, AMQPError.AMQPChannelError>
readonly ackAll: (...parameters: Parameters<Channel["ackAll"]>) => Effect.Effect<void, AMQPError.AMQPChannelError>
readonly nack: (...parameters: Parameters<Channel["nack"]>) => Effect.Effect<void, AMQPError.AMQPChannelError>
readonly nackAll: (...parameters: Parameters<Channel["nackAll"]>) => Effect.Effect<void, AMQPError.AMQPChannelError>
readonly reject: (...parameters: Parameters<Channel["reject"]>) => Effect.Effect<void, AMQPError.AMQPChannelError>
/**
* The boolean is amqplib's write-buffer flag, never a failure signal. It is
* stale when `confirm` is `true`.
*/
readonly publish: (
...parameters: Parameters<Channel["publish"]>
) => Effect.Effect<boolean, AMQPError.AMQPChannelError>
readonly sendToQueue: (
...parameters: Parameters<Channel["sendToQueue"]>
) => Effect.Effect<boolean, AMQPError.AMQPChannelError>
readonly assertQueue: (
...parameters: Parameters<Channel["assertQueue"]>
) => Effect.Effect<Replies.AssertQueue, AMQPError.AMQPChannelError>
readonly checkQueue: (
...parameters: Parameters<Channel["checkQueue"]>
) => Effect.Effect<Replies.AssertQueue, AMQPError.AMQPChannelError>
readonly deleteQueue: (
...parameters: Parameters<Channel["deleteQueue"]>
) => Effect.Effect<Replies.DeleteQueue, AMQPError.AMQPChannelError>
readonly purgeQueue: (
...parameters: Parameters<Channel["purgeQueue"]>
) => Effect.Effect<Replies.PurgeQueue, AMQPError.AMQPChannelError>
readonly bindQueue: (
...parameters: Parameters<Channel["bindQueue"]>
) => Effect.Effect<Replies.Empty, AMQPError.AMQPChannelError>
readonly unbindQueue: (
...parameters: Parameters<Channel["unbindQueue"]>
) => Effect.Effect<Replies.Empty, AMQPError.AMQPChannelError>
readonly assertExchange: (
...parameters: Parameters<Channel["assertExchange"]>
) => Effect.Effect<Replies.AssertExchange, AMQPError.AMQPChannelError>
readonly checkExchange: (
...parameters: Parameters<Channel["checkExchange"]>
) => Effect.Effect<Replies.Empty, AMQPError.AMQPChannelError>
readonly deleteExchange: (
...parameters: Parameters<Channel["deleteExchange"]>
) => Effect.Effect<Replies.Empty, AMQPError.AMQPChannelError>
readonly bindExchange: (
...parameters: Parameters<Channel["bindExchange"]>
) => Effect.Effect<Replies.Empty, AMQPError.AMQPChannelError>
readonly unbindExchange: (
...parameters: Parameters<Channel["unbindExchange"]>
) => Effect.Effect<Replies.Empty, AMQPError.AMQPChannelError>
readonly cancel: (
...parameters: Parameters<Channel["cancel"]>
) => Effect.Effect<Replies.Empty, AMQPError.AMQPChannelError>
readonly get: (
...parameters: Parameters<Channel["get"]>
) => Effect.Effect<GetMessage | false, AMQPError.AMQPChannelError>
readonly prefetch: (
...parameters: Parameters<Channel["prefetch"]>
) => Effect.Effect<Replies.Empty, AMQPError.AMQPChannelError>
readonly recover: (
...parameters: Parameters<Channel["recover"]>
) => Effect.Effect<Replies.Empty, AMQPError.AMQPChannelError>
/** @internal */
readonly close: (config?: internal.CloseChannelOptions) => Effect.Effect<void, never, never>
}
Added in v0.1.0
AMQPChannelOptions (interface)
Signature
export interface AMQPChannelOptions {
retryConnectionSchedule?: Schedule.Schedule<unknown, AMQPError.AMQPConnectionError>
retryConsumptionSchedule?: Schedule.Schedule<unknown, AMQPError.AMQPChannelError>
waitChannelTimeout?: Duration.DurationInput
/**
* When `true`, the channel is opened in publisher-confirm mode and
* `publish` / `sendToQueue` resolve only once the broker has acknowledged
* the message, or fail with an `AMQPChannelError` on a nack, on a channel
* close, or after `confirmTimeout`.
*
* An acknowledgement means the broker took responsibility for the message.
* Unroutable messages are acknowledged too, and surviving a broker restart
* still needs `persistent: true` and a durable queue. A failure may concern
* a message the broker did receive, so retrying can deliver it twice. Each
* publish costs a round trip: run publishes concurrently for throughput.
*
* Defaults to `false`.
*
* @since 0.7.0
*/
confirm?: boolean
/**
* How long a publish waits for the broker's confirmation, and how long
* closing the channel waits for outstanding confirms. Defaults to 30 seconds.
*
* @since 0.7.0
*/
confirmTimeout?: Duration.DurationInput
}
Added in v0.4.0
tags
AMQPChannel
Signature
export declare const AMQPChannel: Context.Tag<AMQPChannel, AMQPChannel>
Added in v0.1.0
type ids
TypeId
Signature
export declare const TypeId: typeof TypeId
Added in v0.1.0
TypeId (type alias)
Signature
export type TypeId = typeof TypeId
Added in v0.1.0