package
1.4.4
Repository: https://github.com/memphisdev/memphis.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Translates a command to a signal number.
ConfigureOptions accepts a flag set and augments it with NATS Server specific flags.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
** added by Memphis.
No description provided by the author
ErrorIs implements: go 1.13 errors.Is(err, target error) bool TODO replace with native code once we no longer support go1.12.
No description provided by the author
limits the amount of time spent waiting for an account fetch to complete.
GatewayDoNotForceInterestOnlyMode is used ONLY in tests.
GenTLSConfig loads TLS related configuration parameters.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
** added by Memphis.
No description provided by the author
No description provided by the author
Determine if this is an encoded stream state.
IsNatsErr determines if an error matches ID, if multiple IDs are given if the error matches any of these the function will be true.
No description provided by the author
No description provided by the author
IsValidLiteralSubject returns true if a subject is valid and literal (no wildcards), false otherwise.
IsValidPublishSubject returns true if a subject is valid and a literal, false otherwise.
IsValidSubject returns true if a subject is valid, false otherwise.
MergeOptions will merge two options giving preference to the flagOpts if the item is present.
New will setup a new server struct after parsing the options.
NewAccount creates a new unlimited account with the given name.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Creates a directory based jwt store.
No description provided by the author
Creates a directory based jwt store.
Creates a directory based jwt store.
NewJSAccountResourcesExceededError creates a new JSAccountResourcesExceededErr error: "resource limits exceeded for account".
NewJSBadRequestError creates a new JSBadRequestErr error: "bad request".
NewJSClusterIncompleteError creates a new JSClusterIncompleteErr error: "incomplete results".
NewJSClusterNoPeersError creates a new JSClusterNoPeersErrF error: "{err}".
NewJSClusterNotActiveError creates a new JSClusterNotActiveErr error: "JetStream not in clustered mode".
NewJSClusterNotAssignedError creates a new JSClusterNotAssignedErr error: "JetStream cluster not assigned to this server".
NewJSClusterNotAvailError creates a new JSClusterNotAvailErr error: "JetStream system temporarily unavailable".
NewJSClusterNotLeaderError creates a new JSClusterNotLeaderErr error: "JetStream cluster can not handle request".
NewJSClusterPeerNotMemberError creates a new JSClusterPeerNotMemberErr error: "peer not a member".
NewJSClusterRequiredError creates a new JSClusterRequiredErr error: "JetStream clustering support required".
NewJSClusterServerNotMemberError creates a new JSClusterServerNotMemberErr error: "server is not a member of the cluster".
NewJSClusterTagsError creates a new JSClusterTagsErr error: "tags placement not supported for operation".
NewJSClusterUnSupportFeatureError creates a new JSClusterUnSupportFeatureErr error: "not currently supported in clustered mode".
NewJSConsumerAlreadyExistsError creates a new JSConsumerAlreadyExists error: "consumer already exists".
NewJSConsumerBadDurableNameError creates a new JSConsumerBadDurableNameErr error: "durable name can not contain '.', '*', '>'".
NewJSConsumerConfigRequiredError creates a new JSConsumerConfigRequiredErr error: "consumer config required".
NewJSConsumerCreateDurableAndNameMismatchError creates a new JSConsumerCreateDurableAndNameMismatch error: "Consumer Durable and Name have to be equal if both are provided".
NewJSConsumerCreateError creates a new JSConsumerCreateErrF error: "{err}".
NewJSConsumerCreateFilterSubjectMismatchError creates a new JSConsumerCreateFilterSubjectMismatchErr error: "Consumer create request did not match filtered subject from create subject".
NewJSConsumerDeliverCycleError creates a new JSConsumerDeliverCycleErr error: "consumer deliver subject forms a cycle".
NewJSConsumerDeliverToWildcardsError creates a new JSConsumerDeliverToWildcardsErr error: "consumer deliver subject has wildcards".
NewJSConsumerDescriptionTooLongError creates a new JSConsumerDescriptionTooLongErrF error: "consumer description is too long, maximum allowed is {max}".
NewJSConsumerDirectRequiresEphemeralError creates a new JSConsumerDirectRequiresEphemeralErr error: "consumer direct requires an ephemeral consumer".
NewJSConsumerDirectRequiresPushError creates a new JSConsumerDirectRequiresPushErr error: "consumer direct requires a push based consumer".
NewJSConsumerDoesNotExistError creates a new JSConsumerDoesNotExist error: "consumer does not exist".
NewJSConsumerDuplicateFilterSubjectsError creates a new JSConsumerDuplicateFilterSubjects error: "consumer cannot have both FilterSubject and FilterSubjects specified".
NewJSConsumerDurableNameNotInSubjectError creates a new JSConsumerDurableNameNotInSubjectErr error: "consumer expected to be durable but no durable name set in subject".
NewJSConsumerDurableNameNotMatchSubjectError creates a new JSConsumerDurableNameNotMatchSubjectErr error: "consumer name in subject does not match durable name in request".
NewJSConsumerDurableNameNotSetError creates a new JSConsumerDurableNameNotSetErr error: "consumer expected to be durable but a durable name was not set".
NewJSConsumerEmptyFilterError creates a new JSConsumerEmptyFilter error: "consumer filter in FilterSubjects cannot be empty".
NewJSConsumerEphemeralWithDurableInSubjectError creates a new JSConsumerEphemeralWithDurableInSubjectErr error: "consumer expected to be ephemeral but detected a durable name set in subject".
NewJSConsumerEphemeralWithDurableNameError creates a new JSConsumerEphemeralWithDurableNameErr error: "consumer expected to be ephemeral but a durable name was set in request".
NewJSConsumerExistingActiveError creates a new JSConsumerExistingActiveErr error: "consumer already exists and is still active".
NewJSConsumerFCRequiresPushError creates a new JSConsumerFCRequiresPushErr error: "consumer flow control requires a push based consumer".
NewJSConsumerFilterNotSubsetError creates a new JSConsumerFilterNotSubsetErr error: "consumer filter subject is not a valid subset of the interest subjects".
NewJSConsumerHBRequiresPushError creates a new JSConsumerHBRequiresPushErr error: "consumer idle heartbeat requires a push based consumer".
NewJSConsumerInactiveThresholdExcessError creates a new JSConsumerInactiveThresholdExcess error: "consumer inactive threshold exceeds system limit of {limit}".
NewJSConsumerInvalidDeliverSubjectError creates a new JSConsumerInvalidDeliverSubject error: "invalid push consumer deliver subject".
NewJSConsumerInvalidPolicyError creates a new JSConsumerInvalidPolicyErrF error: "{err}".
NewJSConsumerInvalidSamplingError creates a new JSConsumerInvalidSamplingErrF error: "failed to parse consumer sampling configuration: {err}".
NewJSConsumerMaxDeliverBackoffError creates a new JSConsumerMaxDeliverBackoffErr error: "max deliver is required to be > length of backoff values".
NewJSConsumerMaxPendingAckExcessError creates a new JSConsumerMaxPendingAckExcessErrF error: "consumer max ack pending exceeds system limit of {limit}".
NewJSConsumerMaxPendingAckPolicyRequiredError creates a new JSConsumerMaxPendingAckPolicyRequiredErr error: "consumer requires ack policy for max ack pending".
NewJSConsumerMaxRequestBatchExceededError creates a new JSConsumerMaxRequestBatchExceededF error: "consumer max request batch exceeds server limit of {limit}".
NewJSConsumerMaxRequestBatchNegativeError creates a new JSConsumerMaxRequestBatchNegativeErr error: "consumer max request batch needs to be > 0".
NewJSConsumerMaxRequestExpiresToSmallError creates a new JSConsumerMaxRequestExpiresToSmall error: "consumer max request expires needs to be >= 1ms".
NewJSConsumerMaxWaitingNegativeError creates a new JSConsumerMaxWaitingNegativeErr error: "consumer max waiting needs to be positive".
NewJSConsumerMetadataLengthError creates a new JSConsumerMetadataLengthErrF error: "consumer metadata exceeds maximum size of {limit}".
NewJSConsumerMultipleFiltersNotAllowedError creates a new JSConsumerMultipleFiltersNotAllowed error: "consumer with multiple subject filters cannot use subject based API".
NewJSConsumerNameContainsPathSeparatorsError creates a new JSConsumerNameContainsPathSeparatorsErr error: "Consumer name can not contain path separators".
NewJSConsumerNameExistError creates a new JSConsumerNameExistErr error: "consumer name already in use".
NewJSConsumerNameTooLongError creates a new JSConsumerNameTooLongErrF error: "consumer name is too long, maximum allowed is {max}".
NewJSConsumerNotFoundError creates a new JSConsumerNotFoundErr error: "consumer not found".
NewJSConsumerOfflineError creates a new JSConsumerOfflineErr error: "consumer is offline".
NewJSConsumerOnMappedError creates a new JSConsumerOnMappedErr error: "consumer direct on a mapped consumer".
NewJSConsumerOverlappingSubjectFiltersError creates a new JSConsumerOverlappingSubjectFilters error: "consumer subject filters cannot overlap".
NewJSConsumerPullNotDurableError creates a new JSConsumerPullNotDurableErr error: "consumer in pull mode requires a durable name".
NewJSConsumerPullRequiresAckError creates a new JSConsumerPullRequiresAckErr error: "consumer in pull mode requires ack policy".
NewJSConsumerPullWithRateLimitError creates a new JSConsumerPullWithRateLimitErr error: "consumer in pull mode can not have rate limit set".
NewJSConsumerPushMaxWaitingError creates a new JSConsumerPushMaxWaitingErr error: "consumer in push mode can not set max waiting".
NewJSConsumerReplacementWithDifferentNameError creates a new JSConsumerReplacementWithDifferentNameErr error: "consumer replacement durable config not the same".
NewJSConsumerReplicasExceedsStreamError creates a new JSConsumerReplicasExceedsStream error: "consumer config replica count exceeds parent stream".
NewJSConsumerReplicasShouldMatchStreamError creates a new JSConsumerReplicasShouldMatchStream error: "consumer config replicas must match interest retention stream's replicas".
NewJSConsumerSmallHeartbeatError creates a new JSConsumerSmallHeartbeatErr error: "consumer idle heartbeat needs to be >= 100ms".
NewJSConsumerStoreFailedError creates a new JSConsumerStoreFailedErrF error: "error creating store for consumer: {err}".
NewJSConsumerWithFlowControlNeedsHeartbeatsError creates a new JSConsumerWithFlowControlNeedsHeartbeats error: "consumer with flow control also needs heartbeats".
NewJSConsumerWQConsumerNotDeliverAllError creates a new JSConsumerWQConsumerNotDeliverAllErr error: "consumer must be deliver all on workqueue stream".
NewJSConsumerWQConsumerNotUniqueError creates a new JSConsumerWQConsumerNotUniqueErr error: "filtered consumer not unique on workqueue stream".
NewJSConsumerWQMultipleUnfilteredError creates a new JSConsumerWQMultipleUnfilteredErr error: "multiple non-filtered consumers not allowed on workqueue stream".
NewJSConsumerWQRequiresExplicitAckError creates a new JSConsumerWQRequiresExplicitAckErr error: "workqueue stream requires explicit ack".
NewJSInsufficientResourcesError creates a new JSInsufficientResourcesErr error: "insufficient resources".
NewJSInvalidJSONError creates a new JSInvalidJSONErr error: "invalid JSON".
NewJSMaximumConsumersLimitError creates a new JSMaximumConsumersLimitErr error: "maximum consumers limit reached".
NewJSMaximumStreamsLimitError creates a new JSMaximumStreamsLimitErr error: "maximum number of streams reached".
NewJSMemoryResourcesExceededError creates a new JSMemoryResourcesExceededErr error: "insufficient memory resources available".
NewJSMirrorConsumerSetupFailedError creates a new JSMirrorConsumerSetupFailedErrF error: "{err}".
NewJSMirrorInvalidStreamNameError creates a new JSMirrorInvalidStreamName error: "mirrored stream name is invalid".
NewJSMirrorInvalidSubjectFilterError creates a new JSMirrorInvalidSubjectFilter error: "mirror subject filter is invalid".
NewJSMirrorMaxMessageSizeTooBigError creates a new JSMirrorMaxMessageSizeTooBigErr error: "stream mirror must have max message size >= source".
NewJSMirrorMultipleFiltersNotAllowedError creates a new JSMirrorMultipleFiltersNotAllowed error: "mirror with multiple subject transforms cannot also have a single subject filter".
NewJSMirrorOverlappingSubjectFiltersError creates a new JSMirrorOverlappingSubjectFilters error: "mirror subject filters can not overlap".
NewJSMirrorWithFirstSeqError creates a new JSMirrorWithFirstSeqErr error: "stream mirrors can not have first sequence configured".
NewJSMirrorWithSourcesError creates a new JSMirrorWithSourcesErr error: "stream mirrors can not also contain other sources".
NewJSMirrorWithStartSeqAndTimeError creates a new JSMirrorWithStartSeqAndTimeErr error: "stream mirrors can not have both start seq and start time configured".
NewJSMirrorWithSubjectFiltersError creates a new JSMirrorWithSubjectFiltersErr error: "stream mirrors can not contain filtered subjects".
NewJSMirrorWithSubjectsError creates a new JSMirrorWithSubjectsErr error: "stream mirrors can not contain subjects".
NewJSNoAccountError creates a new JSNoAccountErr error: "account not found".
NewJSNoLimitsError creates a new JSNoLimitsErr error: "no JetStream default or applicable tiered limit present".
NewJSNoMessageFoundError creates a new JSNoMessageFoundErr error: "no message found".
NewJSNotEmptyRequestError creates a new JSNotEmptyRequestErr error: "expected an empty request payload".
NewJSNotEnabledError creates a new JSNotEnabledErr error: "JetStream not enabled".
NewJSNotEnabledForAccountError creates a new JSNotEnabledForAccountErr error: "JetStream not enabled for account".
NewJSPeerRemapError creates a new JSPeerRemapErr error: "peer remap failed".
NewJSRaftGeneralError creates a new JSRaftGeneralErrF error: "{err}".
NewJSReplicasCountCannotBeNegativeError creates a new JSReplicasCountCannotBeNegative error: "replicas count cannot be negative".
NewJSRestoreSubscribeFailedError creates a new JSRestoreSubscribeFailedErrF error: "JetStream unable to subscribe to restore snapshot {subject}: {err}".
NewJSSequenceNotFoundError creates a new JSSequenceNotFoundErrF error: "sequence {seq} not found".
NewJSSnapshotDeliverSubjectInvalidError creates a new JSSnapshotDeliverSubjectInvalidErr error: "deliver subject not valid".
NewJSSourceConsumerSetupFailedError creates a new JSSourceConsumerSetupFailedErrF error: "{err}".
NewJSSourceDuplicateDetectedError creates a new JSSourceDuplicateDetected error: "duplicate source configuration detected".
NewJSSourceInvalidStreamNameError creates a new JSSourceInvalidStreamName error: "sourced stream name is invalid".
NewJSSourceInvalidSubjectFilterError creates a new JSSourceInvalidSubjectFilter error: "source subject filter is invalid".
NewJSSourceInvalidTransformDestinationError creates a new JSSourceInvalidTransformDestination error: "source transform destination is invalid".
NewJSSourceMaxMessageSizeTooBigError creates a new JSSourceMaxMessageSizeTooBigErr error: "stream source must have max message size >= target".
NewJSSourceMultipleFiltersNotAllowedError creates a new JSSourceMultipleFiltersNotAllowed error: "source with multiple subject transforms cannot also have a single subject filter".
NewJSSourceOverlappingSubjectFiltersError creates a new JSSourceOverlappingSubjectFilters error: "source filters can not overlap".
NewJSStorageResourcesExceededError creates a new JSStorageResourcesExceededErr error: "insufficient storage resources available".
NewJSStreamAssignmentError creates a new JSStreamAssignmentErrF error: "{err}".
NewJSStreamCreateError creates a new JSStreamCreateErrF error: "{err}".
NewJSStreamDeleteError creates a new JSStreamDeleteErrF error: "{err}".
NewJSStreamExternalApiOverlapError creates a new JSStreamExternalApiOverlapErrF error: "stream external api prefix {prefix} must not overlap with {subject}".
NewJSStreamExternalDelPrefixOverlapsError creates a new JSStreamExternalDelPrefixOverlapsErrF error: "stream external delivery prefix {prefix} overlaps with stream subject {subject}".
NewJSStreamGeneralError creates a new JSStreamGeneralErrorF error: "{err}".
NewJSStreamHeaderExceedsMaximumError creates a new JSStreamHeaderExceedsMaximumErr error: "header size exceeds maximum allowed of 64k".
NewJSStreamInfoMaxSubjectsError creates a new JSStreamInfoMaxSubjectsErr error: "subject details would exceed maximum allowed".
NewJSStreamInvalidConfigError creates a new JSStreamInvalidConfigF error: "{err}".
NewJSStreamInvalidError creates a new JSStreamInvalidErr error: "stream not valid".
NewJSStreamInvalidExternalDeliverySubjError creates a new JSStreamInvalidExternalDeliverySubjErrF error: "stream external delivery prefix {prefix} must not contain wildcards".
NewJSStreamLimitsError creates a new JSStreamLimitsErrF error: "{err}".
NewJSStreamMaxBytesRequiredError creates a new JSStreamMaxBytesRequired error: "account requires a stream config to have max bytes set".
NewJSStreamMaxStreamBytesExceededError creates a new JSStreamMaxStreamBytesExceeded error: "stream max bytes exceeds account limit max stream bytes".
NewJSStreamMessageExceedsMaximumError creates a new JSStreamMessageExceedsMaximumErr error: "message size exceeds maximum allowed".
NewJSStreamMirrorNotUpdatableError creates a new JSStreamMirrorNotUpdatableErr error: "stream mirror configuration can not be updated".
NewJSStreamMismatchError creates a new JSStreamMismatchErr error: "stream name in subject does not match request".
NewJSStreamMoveAndScaleError creates a new JSStreamMoveAndScaleErr error: "can not move and scale a stream in a single update".
NewJSStreamMoveInProgressError creates a new JSStreamMoveInProgressF error: "stream move already in progress: {msg}".
NewJSStreamMoveNotInProgressError creates a new JSStreamMoveNotInProgress error: "stream move not in progress".
NewJSStreamMsgDeleteFailedError creates a new JSStreamMsgDeleteFailedF error: "{err}".
NewJSStreamNameContainsPathSeparatorsError creates a new JSStreamNameContainsPathSeparatorsErr error: "Stream name can not contain path separators".
NewJSStreamNameExistError creates a new JSStreamNameExistErr error: "stream name already in use with a different configuration".
NewJSStreamNameExistRestoreFailedError creates a new JSStreamNameExistRestoreFailedErr error: "stream name already in use, cannot restore".
NewJSStreamNotFoundError creates a new JSStreamNotFoundErr error: "stream not found".
NewJSStreamNotMatchError creates a new JSStreamNotMatchErr error: "expected stream does not match".
NewJSStreamOfflineError creates a new JSStreamOfflineErr error: "stream is offline".
NewJSStreamPurgeFailedError creates a new JSStreamPurgeFailedF error: "{err}".
NewJSStreamReplicasNotSupportedError creates a new JSStreamReplicasNotSupportedErr error: "replicas > 1 not supported in non-clustered mode".
NewJSStreamReplicasNotUpdatableError creates a new JSStreamReplicasNotUpdatableErr error: "Replicas configuration can not be updated".
NewJSStreamRestoreError creates a new JSStreamRestoreErrF error: "restore failed: {err}".
NewJSStreamRollupFailedError creates a new JSStreamRollupFailedF error: "{err}".
NewJSStreamSealedError creates a new JSStreamSealedErr error: "invalid operation on sealed stream".
NewJSStreamSequenceNotMatchError creates a new JSStreamSequenceNotMatchErr error: "expected stream sequence does not match".
NewJSStreamSnapshotError creates a new JSStreamSnapshotErrF error: "snapshot failed: {err}".
NewJSStreamStoreFailedError creates a new JSStreamStoreFailedF error: "{err}".
NewJSStreamSubjectOverlapError creates a new JSStreamSubjectOverlapErr error: "subjects overlap with an existing stream".
NewJSStreamTemplateCreateError creates a new JSStreamTemplateCreateErrF error: "{err}".
NewJSStreamTemplateDeleteError creates a new JSStreamTemplateDeleteErrF error: "{err}".
NewJSStreamTemplateNotFoundError creates a new JSStreamTemplateNotFoundErr error: "template not found".
NewJSStreamUpdateError creates a new JSStreamUpdateErrF error: "{err}".
NewJSStreamWrongLastMsgIDError creates a new JSStreamWrongLastMsgIDErrF error: "wrong last msg ID: {id}".
NewJSStreamWrongLastSequenceError creates a new JSStreamWrongLastSequenceErrF error: "wrong last sequence: {seq}".
NewJSTemplateNameNotMatchSubjectError creates a new JSTemplateNameNotMatchSubjectErr error: "template name in subject does not match request".
NewJSTempStorageFailedError creates a new JSTempStorageFailedErr error: "JetStream unable to open temp storage for restore".
No description provided by the author
No description provided by the author
NewServer will setup a new server struct after parsing the options.
No description provided by the author
No description provided by the author
No description provided by the author
NewSublist will create a default sublist with caching enabled per the flag.
NewSublistNoCache will create a default sublist with caching disabled.
NewSublistWithCache will create a default sublist with caching enabled.
NewURLAccResolver returns a new resolver for the given base URL.
NoErrOnUnknownFields can be used to change the behavior the processing of a configuration file.
PrintAndDie is exported for access in other packages.
PrintServerAndExit will print our version and exit.
PrintTLSHelpAndDie prints TLS usage and exits.
ProcessCommandLineArgs takes the command line arguments validating and setting flags for handling in case any sub command was present.
ProcessConfigFile processes a configuration file.
ProcessSignal sends the given signal command to the given process.
ReadOperatorJWT will read a jwt file for an operator claim.
No description provided by the author
RemoveSelfReference removes this server from an array of routes.
No description provided by the author
ResetGatewaysSolicitDelay resets the initial delay before gateways connections are initiated to its default values.
ResponseHandler handles responses for monitoring routes.
RoutesFromStr parses route URLs from a string.
Run starts the NATS server.
No description provided by the author
No description provided by the author
No description provided by the author
SetGatewaysSolicitDelay sets the initial delay before gateways connections are initiated.
SetProcessName allows to change the expected name of the process.
No description provided by the author
No description provided by the author
No description provided by the author
SubjectsCollide will determine if two subjects could both match a single literal subject.
No description provided by the author
Unless ensures that if err is a ApiErr that err will be returned rather than the one being created via the helper.
UnpackIfErrorCtx return Error or, if type is right error and context.
No description provided by the author
No description provided by the author
ValidateMappingDestination returns nil error if the subject is a valid subject mapping destination subject.
No description provided by the author
the function returns a bool for is allowd to create and a bool for if a reload is needed.

# Constants

ACCEPT_MAX_SLEEP is the maximum acceptable sleep times on temporary errors.
ACCEPT_MIN_SLEEP is the minimum acceptable sleep times on temporary errors.
ACCOUNT is for the internal client for accounts.
No description provided by the author
HTTP endpoints.
HTTP endpoints.
AckAll when acking a sequence number, this implicitly acks all sequences below this one as well.
AckExplicit requires ack or nack for all messages.
AckNone requires no acks for delivered messages.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Any is for internals.
Parser constants.
Parser constants.
AUTH_TIMEOUT is the authorization wait time.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Enum for the subject mapping subjectTransform function types.
New stream snapshot capability.
By connection ID.
By the amount of inactivity.
By amount of bytes received.
By number of messages received.
By the last activity.
By amount of bytes sent.
By number of messages sent.
By amount of data in bytes waiting to be sent to client.
By the reason for a closed connection.
By the round trip time.
By connection start time, same as CID.
By the stop time for a closed connection.
By number of subscriptions.
By the amount of time connections exist.
No description provided by the author
Allowable states for a NATS Consensus Group.
No description provided by the author
Service response types.
CLIENT is an end user.
No description provided by the author
No description provided by the author
ClientProtoInfo signals a client can receive more then the original INFO block.
ClientProtoZero is the original Client protocol from 2009.
Allowable states for a NATS Consensus Group.
No description provided by the author
No description provided by the author
Valid Command values.
Valid Command values.
Valid Command values.
Valid Command values.
Compression modes.
Compression modes.
Compression modes.
Compression modes.
Compression modes.
Compression modes.
Compression modes.
Compression modes.
No description provided by the author
No description provided by the author
ConnAll returns all clients.
ConnClosed filters on closed clients.
Parser constants.
ConnectEventMsgType is the schema type for ConnectEventMsg.
ConnOpen filters on open clients.
HTTP endpoints.
Route protocol constants.
CR_LF string.
No description provided by the author
DEFAULT_FETCH_TIMEOUT is the default time that the system will wait for an account fetch to return.
DEFAULT_ALLOW_RESPONSE_EXPIRATION is the default time allowed for a given dynamic response permission.
DEFAULT_ALLOW_RESPONSE_MAX_MSGS is the default number of responses allowed for a reply subject.
No description provided by the author
DEFAULT_CONNECT_ERROR_REPORTS is the number of attempts at which a repeated failed route, gateway or leaf node connection is reported.
No description provided by the author
No description provided by the author
DEFAULT_FLUSH_DEADLINE is the write/flush deadlines.
No description provided by the author
DEFAULT GLOBAL_ACCOUNT.
DEFAULT_HOST defaults to all interfaces.
DEFAULT_HTTP_BASE_PATH is the default base path for monitoring.
DEFAULT_HTTP_PORT is the default monitoring port.
DEFAULT_LAME_DUCK_DURATION is the time in which the server spreads the closing of clients when signaled to go in lame duck mode.
DEFAULT_LAME_DUCK_GRACE_PERIOD is the duration the server waits, after entering lame duck mode, before starting closing client connections.
DEFAULT_LEAF_NODE_RECONNECT LeafNode reconnect interval.
DEFAULT_LEAF_TLS_TIMEOUT TLS timeout for LeafNodes.
DEFAULT_LEAFNODE_INFO_WAIT Route dial timeout.
DEFAULT_LEAFNODE_PORT is the default port for remote leafnode connections.
DEFAULT_MAX_CLOSED_CLIENTS is the maximum number of closed connections we hold onto.
DEFAULT_MAX_CONNECTIONS is the default maximum connections allowed.
DEFAULT_PING_INTERVAL is how often pings are sent to clients, etc...
DEFAULT_PING_MAX_OUT is maximum allowed pings outstanding before disconnect.
** changed by Memphis.
DEFAULT_RECONNECT_ERROR_REPORTS is the default number of failed attempt to reconnect a route, gateway or leaf node connection.
No description provided by the author
DEFAULT_ROUTE_CONNECT Route solicitation intervals.
DEFAULT_ROUTE_DIAL Route dial timeout.
DEFAULT_ROUTE_POOL_SIZE Route default pool size.
DEFAULT_ROUTE_RECONNECT Route reconnect intervals.
DEFAULT_RTT_MEASUREMENT_INTERVAL is how often we want to measure RTT from this server to clients, routes, gateways or leafnode connections.
** added by Memphis.
DEFAULT_SERVICE_EXPORT_RESPONSE_THRESHOLD is the default time that the system will expect a service export response to be delivered.
DEFAULT_SERVICE_LATENCY_SAMPLING is the default sampling rate for service latency metrics.
DEFAULT_SYSTEM_ACCOUNT.
No description provided by the author
DEFAULT_TLS_HANDSHAKE_FIRST_FALLBACK_DELAY is the default amount of time for the server to wait for the TLS handshake with a client to be initiated before falling back to sending the INFO protocol first.
No description provided by the author
No description provided by the author
No description provided by the author
DefaultConnListSize is the default size of the connection list.
DefaultSubListSize is the default size of the subscriptions list.
No description provided by the author
DeliverAll will be the default so can be omitted from the request.
DeliverByStartSequence will look for a defined starting sequence to start.
DeliverByStartTime will select the first messsage with a timestamp >= to StartTime.
DeliverLast will start the consumer with the last sequence received.
DeliverLastPerSubject will start the consumer with the last message for all subjects received.
DeliverNew will only deliver new messages that are sent after the consumer is created.
DiscardNew will error on a StoreMsg call.
DiscardOld will remove older messages to return to the limits.
No description provided by the author
DisconnectEventMsgType is the schema type for DisconnectEventMsg.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
This route was explicitly configured.
File specifies on disk, designated by the JetStream config StoreDir.
FileStoreMaxBlkSize is maximum size we will do for a blk size.
32kib.
Allowable states for a NATS Consensus Group.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GATEWAY is a link between 2 clusters.
HTTP endpoints.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
HTTP endpoints.
Parser constants.
Parser constants.
This route we learned from speaking to other routes.
Copied from go client.
Parser constants.
Route protocol constants.
No description provided by the author
No description provided by the author
interestOnly means that a cluster sends all it subscriptions interest to the gateway, which in return does not send a message unless it knows that there is explicit interest.
InterestPolicy specifies that when all known consumers have acknowledged a message it can be removed.
No description provided by the author
HTTP endpoints.
JETSTREAM is an internal jetstream client.
Server had JetStream enabled.
JetStreamMaxMemDefault is only used when we can't determine system memory.
JetStreamMaxStoreDefault is the default disk storage limit.
Metafiles for streams and consumers.
No description provided by the author
No description provided by the author
JetStreamStoreDir is the prefix we use.
JSAccountResourcesExceededErr resource limits exceeded for account.
JsAckWaitDefault is the default AckWait, only applicable on explicit ack policy consumers.
JSAdvisoryConsumerCreatedPre notification that a template created.
JSAdvisoryConsumerDeletedPre notification that a template deleted.
JSAdvisoryConsumerLeaderElectedPre notification that a replicated consumer has elected a leader.
JSAdvisoryConsumerMaxDeliveryExceedPre is a notification published when a message exceeds its delivery threshold.
JSAdvisoryConsumerMsgNakPre is a notification published when a message has been naked.
JSAdvisoryConsumerMsgTerminatedPre is a notification published when a message has been terminated.
JSAdvisoryConsumerQuorumLostPre notification that a consumer is stalled.
JSAdvisoryPrefix is a prefix for all JetStream advisories.
JSAdvisoryServerOutOfStorage notification that a server has no more storage.
JSAdvisoryServerRemoved notification that a server has been removed from the system.
JSAdvisoryStreamCreatedPre notification that a stream was created.
JSAdvisoryStreamDeletedPre notification that a stream was deleted.
JSAdvisoryStreamLeaderElectedPre notification that a replicated stream has elected a leader.
JSAdvisoryStreamQuorumLostPre notification that a stream and its consumers are stalled.
JSAdvisoryStreamRestoreCompletePre notification that a restore was completed.
JSAdvisoryStreamRestoreCreatePre notification that a restore was start.
JSAdvisoryStreamSnapshotCompletePre notification that a snapshot was completed.
JSAdvisoryStreamSnapshotCreatePre notification that a snapshot was created.
JSAdvisoryStreamUpdatedPre notification that a stream was updated.
JSApiAccountInfo is for obtaining general information about JetStream for this account.
No description provided by the author
JSApiAccountPurge is the endpoint to purge the js content of an account Only works from system account.
No description provided by the author
Request API subjects for JetStream.
No description provided by the author
JSApiConsumerCreate is the endpoint to create consumers for streams.
Request API subjects for JetStream.
Request API subjects for JetStream.
No description provided by the author
Request API subjects for JetStream.
JSApiConsumerDelete is the endpoint to delete consumers.
No description provided by the author
Request API subjects for JetStream.
** added by Memphis for RBAC.
JSApiConsumerInfo is for obtaining general information about a consumer.
No description provided by the author
Request API subjects for JetStream.
** added by Memphis for RBAC.
JSApiConsumerLeaderStepDown is the endpoint to have consumer leader stepdown.
No description provided by the author
Request API subjects for JetStream.
JSApiConsumerList is the endpoint that will return all detailed consumer information.
No description provided by the author
Request API subjects for JetStream.
No description provided by the author
JSApiConsumers is the endpoint to list all consumer names for the stream.
Request API subjects for JetStream.
JSApiDurableCreate is the endpoint to create durable consumers for streams.
Request API subjects for JetStream.
** added by Memphis for RBAC.
JSApiLeaderStepDown is the endpoint to have our metaleader stepdown.
No description provided by the author
No description provided by the author
No description provided by the author
JSApiMsgDelete is the endpoint to delete messages from a stream.
No description provided by the author
Request API subjects for JetStream.
JSApiMsgGet is the template for direct requests for a message by its stream sequence number.
No description provided by the author
Request API subjects for JetStream.
JSApiNamesLimit is the maximum entries we will return for streams or consumers lists.
No description provided by the author
Request API subjects for JetStream.
JSApiRemoveServer is the endpoint to remove a peer server from the cluster.
JSApiRequestNextT is the prefix for the request next message(s) for a consumer in worker/pull mode.
** added by Memphis for RBAC.
JSApiServerStreamCancelMove is the endpoint to cancel a stream move Only works from system account.
Request API subjects for JetStream.
JSApiServerStreamMove is the endpoint to move streams off a server Only works from system account.
Request API subjects for JetStream.
JSApiStreamCreate is the endpoint to create new streams.
No description provided by the author
Request API subjects for JetStream.
JSApiStreamDelete is the endpoint to delete streams.
No description provided by the author
Request API subjects for JetStream.
JSApiStreamInfo is for obtaining general information about a named stream.
No description provided by the author
Request API subjects for JetStream.
JSApiStreamLeaderStepDown is the endpoint to have stream leader stepdown.
No description provided by the author
Request API subjects for JetStream.
JSApiStreamList is the endpoint that will return all detailed stream information.
No description provided by the author
No description provided by the author
JSApiStreamPurge is the endpoint to purge streams.
No description provided by the author
Request API subjects for JetStream.
JSApiStreamRemovePeer is the endpoint to remove a peer from a clustered stream and its consumers.
No description provided by the author
Request API subjects for JetStream.
JSApiStreamRestore is the endpoint to restore a stream from a snapshot.
No description provided by the author
Request API subjects for JetStream.
JSApiStreams is the endpoint to list all stream names for this account.
JSApiStreamSnapshot is the endpoint to snapshot streams.
No description provided by the author
Request API subjects for JetStream.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
JSApiStreamUpdate is the endpoint to update existing streams.
No description provided by the author
Request API subjects for JetStream.
JSApiTemplateCreate is the endpoint to create new stream templates.
Request API subjects for JetStream.
JSApiTemplateDelete is the endpoint to delete stream templates.
Request API subjects for JetStream.
JSApiTemplateInfo is for obtaining general information about a named stream template.
Request API subjects for JetStream.
JSApiTemplates is the endpoint to list all stream template names for this account.
JSAuditAdvisory is a notification about JetStream API access.
JSBadRequestErr bad request.
JSClusterIncompleteErr incomplete results.
JSClusterNoPeersErrF Error causing no peers to be available ({err}).
JSClusterNotActiveErr JetStream not in clustered mode.
JSClusterNotAssignedErr JetStream cluster not assigned to this server.
JSClusterNotAvailErr JetStream system temporarily unavailable.
JSClusterNotLeaderErr JetStream cluster can not handle request.
JSClusterPeerNotMemberErr peer not a member.
JSClusterRequiredErr JetStream clustering support required.
JSClusterServerNotMemberErr server is not a member of the cluster.
JSClusterTagsErr tags placement not supported for operation.
JSClusterUnSupportFeatureErr not currently supported in clustered mode.
JSConsumerAckMetricType is the schema type for JSConsumerAckMetricType.
No description provided by the author
JSConsumerAlreadyExists action CREATE is used for a existing consumer with a different config (consumer already exists).
JSConsumerBadDurableNameErr durable name can not contain '.', '*', '>'.
JSConsumerConfigRequiredErr consumer config required.
JSConsumerCreateDurableAndNameMismatch Consumer Durable and Name have to be equal if both are provided.
JSConsumerCreateErrF General consumer creation failure string ({err}).
JSConsumerCreateFilterSubjectMismatchErr Consumer create request did not match filtered subject from create subject.
JSConsumerDeliverCycleErr consumer deliver subject forms a cycle.
JSConsumerDeliverToWildcardsErr consumer deliver subject has wildcards.
JSConsumerDeliveryExceededAdvisoryType is the schema type for JSConsumerDeliveryExceededAdvisory.
JSConsumerDeliveryNakAdvisoryType is the schema type for JSConsumerDeliveryNakAdvisory.
JSConsumerDeliveryTerminatedAdvisoryType is the schema type for JSConsumerDeliveryTerminatedAdvisory.
JSConsumerDescriptionTooLongErrF consumer description is too long, maximum allowed is {max}.
JSConsumerDirectRequiresEphemeralErr consumer direct requires an ephemeral consumer.
JSConsumerDirectRequiresPushErr consumer direct requires a push based consumer.
JSConsumerDoesNotExist action UPDATE is used for a nonexisting consumer (consumer does not exist).
JSConsumerDuplicateFilterSubjects consumer cannot have both FilterSubject and FilterSubjects specified.
JSConsumerDurableNameNotInSubjectErr consumer expected to be durable but no durable name set in subject.
JSConsumerDurableNameNotMatchSubjectErr consumer name in subject does not match durable name in request.
JSConsumerDurableNameNotSetErr consumer expected to be durable but a durable name was not set.
JSConsumerEmptyFilter consumer filter in FilterSubjects cannot be empty.
JSConsumerEphemeralWithDurableInSubjectErr consumer expected to be ephemeral but detected a durable name set in subject.
JSConsumerEphemeralWithDurableNameErr consumer expected to be ephemeral but a durable name was set in request.
JSConsumerExistingActiveErr consumer already exists and is still active.
JSConsumerFCRequiresPushErr consumer flow control requires a push based consumer.
JSConsumerFilterNotSubsetErr consumer filter subject is not a valid subset of the interest subjects.
JSConsumerHBRequiresPushErr consumer idle heartbeat requires a push based consumer.
JSConsumerInactiveThresholdExcess consumer inactive threshold exceeds system limit of {limit}.
JSConsumerInvalidDeliverSubject invalid push consumer deliver subject.
JSConsumerInvalidPolicyErrF Generic delivery policy error ({err}).
JSConsumerInvalidSamplingErrF failed to parse consumer sampling configuration: {err}.
JSConsumerLeaderElectedAdvisoryType is sent when the system elects a leader for a consumer.
JSConsumerMaxDeliverBackoffErr max deliver is required to be > length of backoff values.
JSConsumerMaxPendingAckExcessErrF consumer max ack pending exceeds system limit of {limit}.
JSConsumerMaxPendingAckPolicyRequiredErr consumer requires ack policy for max ack pending.
JSConsumerMaxRequestBatchExceededF consumer max request batch exceeds server limit of {limit}.
JSConsumerMaxRequestBatchNegativeErr consumer max request batch needs to be > 0.
JSConsumerMaxRequestExpiresToSmall consumer max request expires needs to be >= 1ms.
JSConsumerMaxWaitingNegativeErr consumer max waiting needs to be positive.
JSConsumerMetadataLengthErrF consumer metadata exceeds maximum size of {limit}.
JSConsumerMultipleFiltersNotAllowed consumer with multiple subject filters cannot use subject based API.
JSConsumerNameContainsPathSeparatorsErr Consumer name can not contain path separators.
JSConsumerNameExistErr consumer name already in use.
JSConsumerNameTooLongErrF consumer name is too long, maximum allowed is {max}.
JSConsumerNotFoundErr consumer not found.
JSConsumerOfflineErr consumer is offline.
JSConsumerOnMappedErr consumer direct on a mapped consumer.
JSConsumerOverlappingSubjectFilters consumer subject filters cannot overlap.
JSConsumerPullNotDurableErr consumer in pull mode requires a durable name.
JSConsumerPullRequiresAckErr consumer in pull mode requires ack policy.
JSConsumerPullWithRateLimitErr consumer in pull mode can not have rate limit set.
JSConsumerPushMaxWaitingErr consumer in push mode can not set max waiting.
JSConsumerQuorumLostAdvisoryType is sent when the system detects a clustered consumer and is stalled and unable to make progress.
JSConsumerReplacementWithDifferentNameErr consumer replacement durable config not the same.
JSConsumerReplicasExceedsStream consumer config replica count exceeds parent stream.
JSConsumerReplicasShouldMatchStream consumer config replicas must match interest retention stream's replicas.
JSConsumerSmallHeartbeatErr consumer idle heartbeat needs to be >= 100ms.
Headers for published messages.
JSConsumerStoreFailedErrF error creating store for consumer: {err}.
JSConsumerWithFlowControlNeedsHeartbeats consumer with flow control also needs heartbeats.
JSConsumerWQConsumerNotDeliverAllErr consumer must be deliver all on workqueue stream.
JSConsumerWQConsumerNotUniqueErr filtered consumer not unique on workqueue stream.
JSConsumerWQMultipleUnfilteredErr multiple non-filtered consumers not allowed on workqueue stream.
JSConsumerWQRequiresExplicitAckErr workqueue stream requires explicit ack.
JsDefaultMaxAckPending is set for consumers with explicit ack that do not set the max ack pending.
JsDeleteWaitTimeDefault is the default amount of time we will wait for non-durable consumers to be in an inactive state before deleting them.
This is a direct version of get last by subject, which will be the dominant pattern for KV access once 2.9 is released.
Request API subjects for JetStream.
JSDirectMsgGet is the template for non-api layer direct requests for a message by its stream sequence number or last by subject.
Request API subjects for JetStream.
Headers for published messages.
Headers for published messages.
Headers for published messages.
Headers for published messages.
JsFlowControlMaxPending specifies default pending bytes during flow control that can be outstanding.
JSInsufficientResourcesErr insufficient resources.
JSInvalidJSONErr invalid JSON.
Headers for published messages.
Headers for republished messages and direct gets.
Headers for published messages.
JSMaxDescription is the maximum description length for streams and consumers.
JSMaximumConsumersLimitErr maximum consumers limit reached.
JSMaximumStreamsLimitErr maximum number of streams reached.
JSMaxMetadataLen is the maximum length for streams an consumers metadata map.
JSMaxNameLen is the maximum name lengths for streams, consumers and templates.
JSMaxSubjectDetails The limit of the number of subject details we will send in a stream info response.
JSMemoryResourcesExceededErr insufficient memory resources available.
JSMetricConsumerAckPre is a metric containing ack latency.
JSMetricPrefix is a prefix for all JetStream metrics.
JSMirrorConsumerSetupFailedErrF generic mirror consumer setup failure string ({err}).
JSMirrorInvalidStreamName mirrored stream name is invalid.
JSMirrorInvalidSubjectFilter mirror subject filter is invalid.
JSMirrorMaxMessageSizeTooBigErr stream mirror must have max message size >= source.
JSMirrorMultipleFiltersNotAllowed mirror with multiple subject transforms cannot also have a single subject filter.
JSMirrorOverlappingSubjectFilters mirror subject filters can not overlap.
JSMirrorWithFirstSeqErr stream mirrors can not have first sequence configured.
JSMirrorWithSourcesErr stream mirrors can not also contain other sources.
JSMirrorWithStartSeqAndTimeErr stream mirrors can not have both start seq and start time configured.
JSMirrorWithSubjectFiltersErr stream mirrors can not contain filtered subjects.
JSMirrorWithSubjectsErr stream mirrors can not contain subjects.
** changed by Memphis.
Headers for published messages.
Rollups, can be subject only or all messages.
Rollups, can be subject only or all messages.
Headers for published messages.
JSNoAccountErr account not found.
JSNoLimitsErr no JetStream default or applicable tiered limit present.
JSNoMessageFoundErr no message found.
JSNotEmptyRequestErr expected an empty request payload.
JSNotEnabledErr JetStream not enabled.
JSNotEnabledForAccountErr JetStream not enabled for account.
JSPeerRemapErr peer remap failed.
Headers sent with Request Timeout.
Headers sent with Request Timeout.
Headers sent when batch size was completed, but there were remaining bytes.
JSRaftGeneralErrF General RAFT error string ({err}).
JSReplicasCountCannotBeNegative replicas count cannot be negative.
Headers for published messages.
JSRestoreCompleteAdvisoryType is the schema type for JSSnapshotCreateAdvisory.
JSRestoreCreateAdvisoryType is the schema type for JSSnapshotCreateAdvisory.
JSRestoreSubscribeFailedErrF JetStream unable to subscribe to restore snapshot {subject}: {err}.
Headers for republished messages and direct gets.
JSSequenceNotFoundErrF sequence {seq} not found.
JSServerOutOfStorageAdvisoryType is sent when the server is out of storage space.
JSServerRemovedAdvisoryType is sent when the server has been removed and JS disabled.
JSSnapshotCompleteAdvisoryType is the schema type for JSSnapshotCreateAdvisory.
JSSnapshotCreatedAdvisoryType is the schema type for JSSnapshotCreateAdvisory.
JSSnapshotDeliverSubjectInvalidErr deliver subject not valid.
JSSourceConsumerSetupFailedErrF General source consumer setup failure string ({err}).
JSSourceDuplicateDetected source stream, filter and transform (plus external if present) must form a unique combination (duplicate source configuration detected).
JSSourceInvalidStreamName sourced stream name is invalid.
JSSourceInvalidSubjectFilter source subject filter is invalid.
JSSourceInvalidTransformDestination source transform destination is invalid.
JSSourceMaxMessageSizeTooBigErr stream source must have max message size >= target.
JSSourceMultipleFiltersNotAllowed source with multiple subject transforms cannot also have a single subject filter.
JSSourceOverlappingSubjectFilters source filters can not overlap.
JSStorageResourcesExceededErr insufficient storage resources available.
Headers for republished messages and direct gets.
No description provided by the author
JSStreamAssignmentErrF Generic stream assignment error string ({err}).
JSStreamCreateErrF Generic stream creation error string ({err}).
JSStreamDeleteErrF General stream deletion error string ({err}).
JSStreamExternalApiOverlapErrF stream external api prefix {prefix} must not overlap with {subject}.
JSStreamExternalDelPrefixOverlapsErrF stream external delivery prefix {prefix} overlaps with stream subject {subject}.
JSStreamGeneralErrorF General stream failure string ({err}).
JSStreamHeaderExceedsMaximumErr header size exceeds maximum allowed of 64k.
JSStreamInfoMaxSubjectsErr subject details would exceed maximum allowed.
JSStreamInvalidConfigF Stream configuration validation error string ({err}).
JSStreamInvalidErr stream not valid.
JSStreamInvalidExternalDeliverySubjErrF stream external delivery prefix {prefix} must not contain wildcards.
JSStreamLeaderElectedAdvisoryType is sent when the system elects a leader for a stream.
JSStreamLimitsErrF General stream limits exceeded error string ({err}).
JSStreamMaxBytesRequired account requires a stream config to have max bytes set.
JSStreamMaxStreamBytesExceeded stream max bytes exceeds account limit max stream bytes.
JSStreamMessageExceedsMaximumErr message size exceeds maximum allowed.
JSStreamMirrorNotUpdatableErr stream mirror configuration can not be updated.
JSStreamMismatchErr stream name in subject does not match request.
JSStreamMoveAndScaleErr can not move and scale a stream in a single update.
JSStreamMoveInProgressF stream move already in progress: {msg}.
JSStreamMoveNotInProgress stream move not in progress.
JSStreamMsgDeleteFailedF Generic message deletion failure error string ({err}).
JSStreamNameContainsPathSeparatorsErr Stream name can not contain path separators.
JSStreamNameExistErr stream name already in use with a different configuration.
JSStreamNameExistRestoreFailedErr stream name already in use, cannot restore.
JSStreamNotFoundErr stream not found.
JSStreamNotMatchErr expected stream does not match.
JSStreamOfflineErr stream is offline.
JSStreamPurgeFailedF Generic stream purge failure error string ({err}).
JSStreamQuorumLostAdvisoryType is sent when the system detects a clustered stream and its consumers are stalled and unable to make progress.
JSStreamReplicasNotSupportedErr replicas > 1 not supported in non-clustered mode.
JSStreamReplicasNotUpdatableErr Replicas configuration can not be updated.
JSStreamRestoreErrF restore failed: {err}.
JSStreamRollupFailedF Generic stream rollup failure error string ({err}).
JSStreamSealedErr invalid operation on sealed stream.
JSStreamSequenceNotMatchErr expected stream sequence does not match.
JSStreamSnapshotErrF snapshot failed: {err}.
Headers for published messages.
JSStreamStoreFailedF Generic error when storing a message failed ({err}).
JSStreamSubjectOverlapErr subjects overlap with an existing stream.
JSStreamTemplateCreateErrF Generic template creation failed string ({err}).
JSStreamTemplateDeleteErrF Generic stream template deletion failed error string ({err}).
JSStreamTemplateNotFoundErr template not found.
JSStreamUpdateErrF Generic stream update error string ({err}).
JSStreamWrongLastMsgIDErrF wrong last msg ID: {id}.
JSStreamWrongLastSequenceErrF wrong last sequence: {seq}.
Headers for republished messages and direct gets.
JSTemplateNameNotMatchSubjectErr template name in subject does not match request.
JSTempStorageFailedErr JetStream unable to open temp storage for restore.
Headers for republished messages and direct gets.
JSWaitQueueDefaultMax is the default max number of outstanding requests for pull consumers.
HTTP endpoints.
No description provided by the author
No description provided by the author
Allowable states for a NATS Consensus Group.
LEAF is for leaf node connections.
HTTP endpoints.
LEN_CR_LF hold onto the computed size.
LimitsPolicy (default) means that messages are retained until any given limit is reached.
No description provided by the author
MAX_CONTROL_LINE_SIZE is the maximum allowed protocol control line size.
MAX_CONTROL_LINE_SNIPPET_SIZE is the default size of proto to print on max control line errors.
MAX_HMSG_ARGS Maximum possible number of arguments from HMSG proto.
MAX_HPUB_ARGS Maximum possible number of arguments from HPUB proto.
MAX_MSG_ARGS Maximum possible number of arguments from MSG proto.
No description provided by the author
MAX_PAYLOAD_MAX_SIZE is the size at which the server will warn about max_payload being too high.
MAX_PAYLOAD_SIZE is the maximum allowed payload size.
MAX_PENDING_SIZE is the maximum outbound pending bytes per client.
MAX_PUB_ARGS Maximum possible number of arguments from PUB proto.
MAX_RMSG_ARGS Maximum possible number of arguments from RMSG proto.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MemoryStorage specifies in memory only.
No description provided by the author
No description provided by the author
MEMPHIS_VERSION is the current version for the memphis server.
No description provided by the author
Parser constants.
No description provided by the author
No description provided by the author
MQTT client.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Regular NATS client.
No description provided by the author
No description provided by the author
No description provided by the author
If the connection is not a CLIENT connection.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Enum for the subject mapping subjectTransform function types.
OCSPModeAlways enforces OCSP stapling for certs and shuts down the server in case a server is revoked or cannot get OCSP staples.
OCSPModeAuto staples a status, only if "status_request" is set in cert.
OCSPModeMust honors the Must-Staple flag from a certificate but also causing shutdown in case the certificate has been revoked.
OCSPModeNever disables OCSP stapling even if cert has Must-Staple flag.
OCSPPeerChainlinkInvalidEventMsgType is the schema type for OCSPPeerChainlinkInvalidEventMsg.
OCSPPeerRejectEventMsgType is the schema type for OCSPPeerRejectEventMsg.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OK.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
Parser constants.
optimistic is the default mode where a cluster will send to a gateway unless it is been told that there is no interest (this is for plain subscribers only).
No description provided by the author
Enum for the subject mapping subjectTransform function types.
No description provided by the author
No description provided by the author
No description provided by the author
PROTO is the currently supported protocol.
PROTO_SNIPPET_SIZE is the default size of proto to print on parse errors.
No description provided by the author
Parser constants.
RANDOM_PORT is the value for port that, when supplied, will cause the server to listen on a randomly-chosen available port.
No description provided by the author
No description provided by the author
No description provided by the author
ReplayInstant will replay messages as fast as possible.
ReplayOriginal will maintain the same timing as the messages were received.
No description provided by the author
No description provided by the author
HTTP endpoints.
RouteProtoInfo signals a route can receive more then the original INFO block.
RouteProtoV2 is the new route/cluster protocol that provides account support.
RouteProtoZero is the original Route protocol from 2009.
ROUTER represents another server in the cluster.
No description provided by the author
HTTP endpoints.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ServiceLatencyType is the NATS Event Type for ServiceLatency.
No description provided by the author
Service response types.
Enum for the subject mapping subjectTransform function types.
Enum for the subject mapping subjectTransform function types.
No description provided by the author
No description provided by the author
Enum for the subject mapping subjectTransform function types.
Enum for the subject mapping subjectTransform function types.
Enum for the subject mapping subjectTransform function types.
HTTP endpoints.
No description provided by the author
StreamDefaultDuplicatesWindow default duplicates window.
Service response types.
Replicas Range.
Parser constants.
HTTP endpoints.
SYSTEM is an internal system client.
No description provided by the author
No description provided by the author
TLS_TIMEOUT is the TLS wait time.
No description provided by the author
transitioning is when a gateway has to send too many no interest on subjects to the remote and decides that it is now time to move to modeInterestOnly (this is on a per account basis).
Parser constants.
HTTP endpoints.
VERSION is the current version for the NATS server.
Enum for the subject mapping subjectTransform function types.
WorkQueuePolicy specifies that when the first worker or subscriber acknowledges the message it can be removed.
No description provided by the author
No description provided by the author
No description provided by the author
Websocket client.

# Variables

nil or no payload to ack subject also means ACK.
Nack.
Ack + Deliver the next message(s).
deprecated but +OK meant ack as well.
Progress indicator.
Terminate delivery of the message.
No description provided by the author
errors.
errors.
errors.
errors.
errors.
errors.
errors.
errors.
errors.
ErrAccountExists is returned when an account is attempted to be registered but already exists.
ErrAccountExpired is returned when an account has expired.
*** added by Memphis ErrAccountId represents an error condition on missing/wrong account id.
ErrAccountResolverSameClaims is returned when same claims have been fetched.
ErrAccountResolverUpdateTooSoon is returned when we attempt an update too soon to last request.
ErrAccountValidation is returned when an account has failed validation.
Sublist related errors.
ErrAuthentication represents an error condition on failed authentication.
ErrAuthExpired represents an expired authorization due to timeout.
ErrAuthTimeout represents an error condition on failed authorization due to timeout.
ErrBadAccount represents a malformed or incorrect account.
ErrBadClientProtocol signals a client requested an invalid client protocol.
errors.
ErrBadMsgHeader signals the parser detected a bad message header.
ErrBadPublishSubject represents an error condition for an invalid publish subject.
ErrBadQualifier is used to error on a bad qualifier for a transform.
ErrBadSampling is returned when the sampling for latency tracking is not 1 >= sample <= 100.
ErrBadServiceType is returned when latency tracking is being applied to non-singleton response types.
No description provided by the author
ErrBadSubject represents an error condition for an invalid subject.
ErrCertNotPinned is returned when pinned certs are set and the certificate is not in it.
ErrClientConnectedToLeafNodePort represents an error condition when a client attempted to connect to the leaf node listen port.
ErrClientConnectedToRoutePort represents an error condition when a client attempted to connect to the route listen port.
ErrClientOrRouteConnectedToGatewayPort represents an error condition when a client or route attempted to connect to the Gateway port.
ErrClusterNameConfigConflict signals that the options for cluster name in cluster and gateway are in conflict.
ErrClusterNameRemoteConflict signals that a remote server has a different cluster name.
ErrConnectedToWrongPort represents an error condition when a connection is attempted to the wrong listen port (for instance a LeafNode to a client port, etc...).
ErrConnectionClosed represents an error condition on a closed connection.
ErrCorruptStreamState.
ErrCycleSearchDepth is returned when we have exceeded our maximum search depth..
ErrDuplicateServerName is returned when processing a server remote connection and the server reports that this server name is already used in the cluster.
ErrImportFormsCycle is returned when an import would form a cycle.
ErrInvalidMappingDestination is used for all subject mapping destination errors.
ErrInvalidMappingDestinationSubject is used to error on a bad transform destination mapping.
ErrInvalidSequence is returned when the sequence is not present in the stream store.
Sublist related errors.
ErrJetStreamConsumerAlreadyUsed Deprecated by JSConsumerNameExistErr ApiError, use IsNatsError() for comparisons.
ErrJetStreamNotAssigned Deprecated by JSClusterNotAssignedErr ApiError, use IsNatsError() for comparisons.
ErrJetStreamNotClustered Deprecated by JSClusterNotActiveErr ApiError, use IsNatsError() for comparisons.
ErrJetStreamNotEnabled Deprecated by JSNotEnabledErr ApiError, use IsNatsError() for comparisons.
ErrJetStreamNotLeader Deprecated by JSClusterNotLeaderErr ApiError, use IsNatsError() for comparisons.
ErrJetStreamResourcesExceeded Deprecated by JSInsufficientResourcesErr ApiError, use IsNatsError() for comparisons.
ErrJetStreamStreamAlreadyUsed Deprecated by JSStreamNameExistErr ApiError, use IsNatsError() for comparisons.
ErrJetStreamStreamNotFound Deprecated by JSStreamNotFoundErr ApiError, use IsNatsError() for comparisons.
ErrLeafNodeDisabled is when we disable leafnodes.
ErrLeafNodeHasSameClusterName represents an error condition when a leafnode is a cluster and it has the same cluster name as the hub cluster.
ErrMalformedSubject is returned when a subscription is made with a subject that does not conform to subject rules.
ErrMappingDestinationIndexOutOfRange is returned when the mapping destination function is passed an out of range wildcard index value for one of it's arguments.
ErrMappingDestinationInvalidArg is returned when the mapping destination function is passed and invalid argument.
ErrMappingDestinationNotEnoughArgs is returned when the mapping destination function is not passed enough arguments.
ErrMappingDestinationNotSupportedForImport is returned when you try to use a mapping function other than wildcard in a transform that needs to be reversible (i.e.
ErrMappingDestinationNotUsingAllWildcards is used to error on a transform destination not using all of the token wildcards.
ErrMappingDestinationTooManyArgs is returned when the mapping destination function is passed too many arguments.
ErrMaxBytes is returned when we have discard new as a policy and we reached the bytes limit.
ErrMaxControlLine represents an error condition when the control line is too big.
ErrMaxMsgs is returned when we have discard new as a policy and we reached the message limit.
ErrMaxMsgsPerSubject is returned when we have discard new as a policy and we reached the message limit per subject.
ErrMaxPayload represents an error condition when the payload is too big.
ErrMemoryResourcesExceeded Deprecated by JSMemoryResourcesExceededErr ApiError, use IsNatsError() for comparisons.
ErrMinimumVersionRequired is returned when a connection is not at the minimum version required.
ErrMissingAccount is returned when an account does not exist.
ErrMissingService is returned when an account does not have an exported service.
ErrMsgHeadersNotSupported signals the parser detected a message header but they are not supported on this server.
ErrMsgTooLarge is returned when a message is considered too large.
Sublist related errors.
ErrNoAccountResolver is returned when we attempt an update but do not have an account resolver.
ErrNoAckPolicy is returned when trying to update a consumer's acks with no ack policy.
ErrNoRespondersRequiresHeaders signals that a client needs to have headers on if they want no responders behavior.
No description provided by the author
ErrNoSysAccount is returned when an attempt to publish or subscribe is made when there is no internal system account defined.
Sublist related errors.
ErrNoTransforms signals no subject transforms are available to map this subject.
ErrReplicasNotSupported Deprecated by JSStreamReplicasNotSupportedErr ApiError, use IsNatsError() for comparisons.
ErrReservedAccount represents a reserved account that can not be created.
ErrReservedPublishSubject represents an error condition when sending to a reserved subject, e.g.
ErrRevocation is returned when a credential has been revoked.
ErrSequenceMismatch is returned when storing a raw message and the expected sequence is wrong.
ErrServerNotRunning is used to signal an error that a server is not running.
ErrServiceImportAuthorization is returned when a service import is not authorized.
ErrStorageResourcesExceeded Deprecated by JSStorageResourcesExceededErr ApiError, use IsNatsError() for comparisons.
ErrStoreClosed is returned when the store has been closed.
ErrStoreEOF is returned when message seq is greater than the last sequence.
ErrStoreMsgNotFound when message was not found but was expected to be.
ErrStoreSnapshotInProgress is returned when RemoveMsg or EraseMsg is called while a snapshot is in progress.
ErrStoreWrongType is for when you access the wrong storage type.
ErrStreamImportAuthorization is returned when a stream import is not authorized.
ErrStreamImportBadPrefix is returned when a stream import prefix contains wildcards.
ErrStreamImportDuplicate is returned when a stream import is a duplicate of one that already exists.
ErrSubscribePermissionViolation is returned when processing of a subscription fails due to permissions.
ErrTooManyAccountConnections signals that an account has reached its maximum number of active connections.
ErrTooManyConnections signals a client that the maximum number of connections supported by the server has been reached.
ErrTooManySubs signals a client that the maximum number of subscriptions per connection has been reached.
ErrTooManySubTokens signals a client that the subject has too many tokens.
ErrUnknownMappingDestinationFunction is returned when a subject mapping destination contains an unknown mustache-escaped mapping function.
No description provided by the author
ErrWrongGateway represents an error condition when a server receives a connect request from a remote Gateway with a destination name that does not match the server's Gateway's name.
FlagSnapshot captures the server options as specified by CLI flags at startup.
errors.
errors.
No description provided by the author
IsPublicExport is a placeholder to denote a public export.
No description provided by the author
No description provided by the author
No description provided by the author
errors.
errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
errors.
errors.
errors.
errors.
errors.
errors.

# Structs

Options for account Info.
Account are subject namespace definitions.
No description provided by the author
No description provided by the author
AccountGatewayz represents interest mode for this account.
No description provided by the author
AccountNumConns is an event that will be sent from a server that is tracking a given account when the number of connections changes.
AccountStat contains the data common between AccountNumConns and AccountStatz.
Leafz represents detailed information on Leafnodes.
In the context of system events, AccountzEventOptions are options passed to Accountz.
LeafzOptions are options passed to Leafz.
No description provided by the author
In the context of system events, AccountzEventOptions are options passed to Accountz.
AccountzOptions are options passed to Accountz.
ApiError is included in all responses if there was an error.
ApiPaged includes variables used to create paged responses from the JSON API.
ApiPagedRequest includes parameters allowing specific pages to be requests from APIs responding with ApiPaged.
ApiResponse is a standard response from the JetStream JSON API.
No description provided by the author
No description provided by the author
AuthCallout option used to map external AuthN to NATS based AuthZ.
No description provided by the author
No description provided by the author
No description provided by the author
Caching resolver using nats for lookups and making use of a directory for storage.
ClientInfo is detailed information about the client forming a connection.
No description provided by the author
ClusterInfo shows information about the underlying set of servers that make up the stream or consumer.
ClusterOpts are options for clusters.
ClusterOptsVarz contains monitoring cluster information.
CommittedEntry is handed back to the user to apply a commit to their upper layer.
No description provided by the author
CompressionOpts defines the compression mode and optional configuration.
No description provided by the author
ConnectEventMsg is sent when a new connection is made that is part of an account.
No description provided by the author
ConnInfo has detailed information on a per connection basis.
Connz represents detailed information on current client connections.
In the context of system events, ConnzEventOptions are options passed to Connz.
ConnzOptions are the options passed to Connz().
No description provided by the author
No description provided by the author
ConsumerNakOptions is for optional NAK values, e.g.
No description provided by the author
ConsumerState represents a stored state for a consumer.
No description provided by the author
No description provided by the author
No description provided by the author
DataStats reports how may msg and bytes.
DeleteRange is a run length encoded delete range.
DenyRules Contains lists of subjects not allowed to be imported/exported.
Resolver based on nats for synchronization and backing directory for storage.
DirJWTStore implements the JWT Store interface, keeping JWTs in an optionally sharded directory structure.
DisconnectEventMsg is sent when a new connection previously defined from a ConnectEventMsg is closed.
No description provided by the author
Entry
No description provided by the author
ErrorsData is the source data for generated errors as found in errors.json.
Common filter options for system requests STATSZ VARZ SUBSZ CONNZ ROUTEZ GATEWAYZ LEAFZ.
ExternalStream allows you to qualify access to a stream source in another account.
No description provided by the author
No description provided by the author
No description provided by the author
File ConsumerInfo is used for creating consumer stores.
No description provided by the author
FileStreamInfo allows us to remember created time.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GatewayOpts are options for gateways.
GatewayOptsVarz contains monitoring gateway information.
GatewayStat holds gateway statistics.
Gatewayz represents detailed information on Gateways.
In the context of system events, GatewayzEventOptions are options passed to Gatewayz.
GatewayzOptions are the options passed to Gatewayz().
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
In the context of system events, HealthzEventOptions are options passed to Healthz.
HealthzOptions are options passed to Healthz.
Info is the information sent to clients, routes, gateways, and leaf nodes, to help them understand information about this server.
No description provided by the author
No description provided by the author
JetStreamAccountStats returns current statistics about the account's JetStream usage.
No description provided by the author
JetStreamConfig determines this server's configuration.
Statistics about JetStream for this server.
No description provided by the author
JetStreamVarz contains basic runtime information about jetstream.
JSApiAccountInfoResponse reports back information on jetstream for this account.
JSApiAccountPurgeResponse is the response to a purge request in the meta group.
JSAPIAudit is an advisory about administrative actions taken on JetStream.
No description provided by the author
No description provided by the author
JSApiConsumerGetNextRequest is for getting next messages for pull based consumers.
No description provided by the author
JSApiConsumerLeaderStepDownResponse is the response to a consumer leader stepdown request.
No description provided by the author
No description provided by the author
No description provided by the author
JSApiLeaderStepdownRequest allows placement control over the meta leader placement.
JSApiLeaderStepDownResponse is the response to a meta leader stepdown request.
JSApiMetaServerRemoveRequest will remove a peer from the meta group.
JSApiMetaServerRemoveResponse is the response to a peer removal request in the meta group.
JSApiMetaServerStreamMoveRequest will move a stream on a server to another response to this will come as JSApiStreamUpdateResponse/JSApiStreamUpdateResponseType.
JSApiMsgDeleteRequest delete message request.
No description provided by the author
JSApiMsgGetRequest get a message request.
No description provided by the author
JSApiStreamCreateResponse stream creation.
JSApiStreamDeleteResponse stream removal.
No description provided by the author
No description provided by the author
JSApiStreamLeaderStepDownResponse is the response to a leader stepdown request.
No description provided by the author
JSApiStreamListResponse list of detailed stream information.
No description provided by the author
JSApiStreamNamesResponse list of streams.
JSApiStreamPurgeRequest is optional request information to the purge API.
No description provided by the author
JSApiStreamRemovePeerRequest is the required remove peer request.
JSApiStreamRemovePeerResponse is the response to a remove peer request.
JSApiStreamRestoreRequest is the required restore request.
JSApiStreamRestoreResponse is the direct response to the restore request.
No description provided by the author
JSApiStreamSnapshotResponse is the direct response to the snapshot request.
JSApiStreamTemplateCreateResponse for creating templates.
No description provided by the author
JSApiStreamTemplateInfoResponse for information about stream templates.
JSApiStreamTemplateNamesResponse list of templates.
No description provided by the author
JSApiStreamUpdateResponse for updating a stream.
JSConsumerAckMetric is a metric published when a user acknowledges a message, the number of these that will be published is dependent on SampleFrequency.
JSConsumerActionAdvisory indicates that a consumer was created or deleted.
JSConsumerDeliveryExceededAdvisory is an advisory informing that a message hit its MaxDeliver threshold and so might be a candidate for DLQ handling.
JSConsumerDeliveryNakAdvisory is an advisory informing that a message was naked by the consumer.
JSConsumerDeliveryTerminatedAdvisory is an advisory informing that a message was terminated by the consumer, so might be a candidate for DLQ handling.
JSConsumerLeaderElectedAdvisory indicates that a stream has lost quorum and is stalled.
JSConsumerQuorumLostAdvisory indicates that a consumer has lost quorum and is stalled.
JSInfo has detailed information on JetStream.
No description provided by the author
JSPubAckResponse is a formal response to a publish operation.
JSRestoreCompleteAdvisory is an advisory sent after a snapshot is successfully started.
JSRestoreCreateAdvisory is an advisory sent after a snapshot is successfully started.
JSServerOutOfSpaceAdvisory indicates that a stream has lost quorum and is stalled.
JSServerRemovedAdvisory indicates that a stream has lost quorum and is stalled.
JSSnapshotCompleteAdvisory is an advisory sent after a snapshot is successfully started.
JSSnapshotCreateAdvisory is an advisory sent after a snapshot is successfully started.
JSStreamActionAdvisory indicates that a stream was created, edited or deleted.
JSStreamLeaderElectedAdvisory indicates that a stream has lost quorum and is stalled.
JSStreamQuorumLostAdvisory indicates that a stream has lost quorum and is stalled.
In the context of system events, JszEventOptions are options passed to Jsz.
JSzOptions are options passed to Jsz.
No description provided by the author
No description provided by the author
LeafInfo has detailed information on each remote leafnode connection.
LeafNodeOpts are options for a given server to accept leaf node connections and/or connect to a remote cluster.
LeafNodeOptsVarz contains monitoring leaf node information.
Leafz represents detailed information on Leafnodes.
In the context of system events, LeafzEventOptions are options passed to Leafz.
LeafzOptions are options passed to Leafz.
LocalCache is a local file implementation of OCSPResponseCache.
No description provided by the author
LostStreamData indicates msgs that have been lost.
No description provided by the author
MapDest is for mapping published subjects for clients.
MemAccResolver is a memory only resolver.
MetaClusterInfo shows information about the meta group.
No description provided by the author
MQTTOpts are options for MQTT.
MQTTOptsVarz contains monitoring MQTT information.
No description provided by the author
No description provided by the author
No description provided by the author
NkeyUser is for multiple nkey based users.
NoOpCache is a no-op implementation of OCSPResponseCache.
No description provided by the author
No description provided by the author
OCSPConfig represents the options of OCSP stapling options.
OCSPMonitor monitors the state of a staple per certificate.
OCSPPeerChainlinkInvalidEventMsg is sent when a certificate (link) in a valid TLS chain is found to be OCSP invalid during a peer TLS handshake.
OCSPPeerRejectEventMsg is sent when a peer TLS handshake is ultimately rejected due to OCSP invalidation.
No description provided by the author
No description provided by the author
No description provided by the author
OCSPResponseCacheVarz contains OCSP response cache information.
Options block for nats-server.
No description provided by the author
PeerInfo shows information about all the peers in the cluster that are supporting the stream or consumer.
Represents a pending message for explicit ack or ack all.
Permissions are the allowed subjects on a per publish or subscribe basis.
Used to guide placement of streams and meta controllers in clustered JetStream.
No description provided by the author
Ports describes URLs that the server can be contacted in.
No description provided by the author
No description provided by the author
In the context of system events, ProfilezEventOptions are options passed to Profilez.
ProfilezOptions are options passed to Profilez.
No description provided by the author
PubAck is the detail you get back from a publish to a stream that was successful.
No description provided by the author
RaftGroupDetail shows information details about the Raft group.
RemoteGatewayOpts are options for connecting to a remote gateway NOTE: This structure is no longer used for monitoring endpoints and json tags are deprecated and may be removed in the future.
RemoteGatewayOptsVarz contains monitoring remote gateway information.
RemoteGatewayz represents information about an outbound connection to a gateway.
RemoteLeafOpts are options for connecting to a remote server as a leaf node.
RemoteLeafOptsVarz contains monitoring remote leaf node information.
RePublish is for republishing messages once committed to a stream.
ResponsePermission can be used to allow responses to any reply subject that is received on a valid subscription.
RouteInfo has detailed information on a per connection basis.
RoutePermissions are similar to user permissions but describe what a server can import/export from and to another server.
RouteStat holds route statistics.
Routez represents detailed information on current client connections.
In the context of system events, RoutezEventOptions are options passed to Routez.
RoutezOptions are options passed to Routez.
No description provided by the author
No description provided by the author
SequenceInfo has both the consumer and the stream sequence and last activity.
SequencePair has both the consumer and the stream sequence.
Server is our main struct.
ServerAPIConnzResponse is the response type connz.
ServerAPIResponse is the response type for the server API like varz, connz etc.
ServerID is basic static info for a server.
ServerInfo identifies remote servers.
ServerStats hold various statistics that we will periodically send out.
ServerStatsMsg is sent periodically with stats updates.
ServiceLatency is the JSON message sent out in response to latency tracking for an accounts exported services.
SimpleState for filtered subject specific state.
SlowConsumersStats contains information about the slow consumers from different type of connections.
SnapshotResult contains information about the snapshot.
No description provided by the author
No description provided by the author
StatszEventOptions are options passed to Statsz.
StoredMsg is for raw access to messages in a stream.
StoreMsg is the stored message format for messages that are retained by the Store layer.
No description provided by the author
StreamConfig will determine the name, subjects and retention policy for a given stream.
No description provided by the author
StreamDetail shows information about the stream state and its consumers.
StreamInfo shows config and current state for this stream.
StreamReplicatedState represents what is encoded in a binary stream snapshot used for stream replication in an NRG.
StreamSource dictates how streams can source from other streams.
StreamSourceInfo shows information about an upstream stream source.
StreamState is information about the given stream.
StreamTemplateConfig allows a configuration to auto-create streams based on this template when a message is received that matches.
StreamTemplateInfo.
SubDetail is for verbose information for subscriptions.
SubjectPermission is an individual allow and deny struct for publish and subscribe authorizations.
SubjectTransformConfig is for applying a subject transform (to matching messages) before doing anything else when a new message is received.
A Sublist stores and efficiently retrieves subscriptions.
SublistResult is a result structure better optimized for queue subs.
SublistStats are public stats for the sublist.
Subsz represents detail information on current connections.
In the context of system events, SubzEventOptions are options passed to Subz.
SubszOptions are the options passed to Subsz.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TLSConfigOpts holds the parsed tls config information, used with flag parsing.
TLSPeerCert contains basic information about a TLS peer certificate.
TypedEvent is a event or advisory sent by the server that has nats type hints typically used for events that might be consumed by 3rd party event systems.
URLAccResolver implements an http fetcher.
User is for multiple accounts/users.
No description provided by the author
UserInfo returns basic information to a user about bound account and user permissions.
No description provided by the author
Varz will output server information on the monitoring port at /varz.
In the context of system events, VarzEventOptions are options passed to Varz.
VarzOptions are the options passed to Varz().
WebsocketOpts are options for websocket.
WebsocketOptsVarz contains monitoring websocket information.

# Interfaces

AccountResolver interface.
Authentication is an interface for implementing authentication.
ClientAuthentication is an interface for client authentication.
ConsumerStore stores state on consumers for streams.
Interface for DeleteBlock.
Logger interface of the NATS Server.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SubjectTransformer transforms subjects using mappings This API is not part of the public API and not subject to SemVer protections.
TemplateStore stores templates.
No description provided by the author

# Type aliases

AckPolicy determines how the consumer should acknowledge delivered messages.
ActionAdvisoryType indicates which action against a stream, consumer or template triggered an advisory.
ClosedState is the reason client was closed.
Command is a signal used to control a running nats-server process.
ConnInfos represents a connection info list.
ConnState is for filtering states of connections.
No description provided by the author
No description provided by the author
Legacy []uint64.
DeliverPolicy determines how the consumer should select the first message to deliver.
No description provided by the author
Discard Policy determines how we proceed when limits of messages or bytes are hit.
No description provided by the author
No description provided by the author
ErrorOption configures a NATS Error helper.
No description provided by the author
GatewayInterestMode represents an account interest mode for a gateway connection.
No description provided by the author
JWTChanged functions are called when the store file watcher notices a JWT changed.
No description provided by the author
No description provided by the author
No description provided by the author
PinnedCertSet is a set of lower case hex-encoded sha256 of DER encoded SubjectPublicKeyInfo.
No description provided by the author
ReplayPolicy determines how the consumer should replay messages it already has queued in the stream.
RetentionPolicy determines how messages in a set are retained.
RouteType designates the router type.
Type for our server capabilities.
ServiceRespType represents the types of service request response types.
SignatureHandler is used to sign a nonce from the server while authenticating with Nkeys.
SortOpt is a helper type to sort clients.
StorageType determines how messages are stored for retention.
Used to call back into the upper layers to report on changes in storage resources.
No description provided by the author
No description provided by the author