AMQPConnection overview
Added in v0.1.0
Table of contents
Layers
layer
Signature
export declare const layer: (
url: internal.ConnectionUrl,
options?: AMQPConnectionOptions
) => Layer.Layer<AMQPConnection, AMQPError.AMQPConnectionError>
Added in v0.1.0
constructors
make
Signature
export declare const make: (
url: internal.ConnectionUrl,
options?: AMQPConnectionOptions
) => Effect.Effect<AMQPConnection, AMQPError.AMQPConnectionError, Scope.Scope>
Added in v0.1.0
models
AMQPConnection (interface)
Signature
export interface AMQPConnection {
readonly [TypeId]: TypeId
readonly createChannel: Effect.Effect<Channel, AMQPError.AMQPConnectionError, never>
readonly createConfirmChannel: Effect.Effect<ConfirmChannel, AMQPError.AMQPConnectionError, never>
readonly serverProperties: Effect.Effect<AMQPConnectionServerProperties, AMQPError.AMQPConnectionError, never>
readonly updateSecret: (
...params: Parameters<ChannelModel["updateSecret"]>
) => Effect.Effect<void, AMQPError.AMQPConnectionError, never>
/** @internal */
readonly close: (options: internal.CloseConnectionOptions) => Effect.Effect<void, never, never>
}
Added in v0.1.0
AMQPConnectionOptions (type alias)
Signature
export type AMQPConnectionOptions = {
/**
* Schedule for retrying connection after disconnection.
* Default: retry forever with 1 second delay between attempts.
*/
retryConnectionSchedule?: Schedule.Schedule<unknown, AMQPError.AMQPConnectionError>
/**
* Timeout for waiting on an existing connection to become available
* (used by createChannel, serverProperties, etc. during reconnection).
* Default: 5 seconds.
*/
waitConnectionTimeout?: Duration.DurationInput
/**
* Timeout for establishing a new connection. This applies to both the
* TCP socket connection and the AMQP handshake. If the connection is
* not established within this time, an AMQPConnectionError is thrown.
* Default: 10 seconds.
*
* @since 0.7.0
*/
connectionTimeout?: Duration.DurationInput
}
Added in v0.4.0
AMQPConnectionServerProperties (type alias)
Signature
export type AMQPConnectionServerProperties = ServerProperties & {
hostname: string | undefined
port: string | undefined
}
Added in v0.2.5
tags
AMQPConnection
Signature
export declare const AMQPConnection: Context.Tag<AMQPConnection, AMQPConnection>
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