Skip to content

Commit

Permalink
[DOCS] Fix the batch delay default value in versioned docs (apache#9528)
Browse files Browse the repository at this point in the history
* test

* test

* update versioned docs

* update master
  • Loading branch information
sijia-w authored Feb 9, 2021
1 parent 71bc841 commit d5edbd9
Show file tree
Hide file tree
Showing 25 changed files with 108 additions and 108 deletions.
12 changes: 6 additions & 6 deletions site2/docs/client-libraries-cgo.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Currently, the following Go clients are maintained in two repositories.
| CGo | [pulsar-client-go](https://github.com/apache/pulsar/tree/master/pulsar-client-go) | [Apache Pulsar](https://github.com/apache/pulsar) | [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) | CGo client that depends on C++ client library |
| Go | [pulsar-client-go](https://github.com/apache/pulsar-client-go) | [Apache Pulsar](https://github.com/apache/pulsar) | [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) | A native golang client |

> #### API docs available as well
> **API docs available as well**
> For standard API docs, consult the [Godoc](https://godoc.org/github.com/apache/pulsar/pulsar-client-go/pulsar).
## Installation
Expand All @@ -27,7 +27,7 @@ the instructions for [C++ library](client-libraries-cpp.md) for installing the b

### Install go package

> #### Compatibility Warning
> **Compatibility Warning**
> The version number of the Go client **must match** the version number of the Pulsar C++ client library.
You can install the `pulsar` library locally using `go get`. Note that `go get` doesn't support fetching a specific tag - it will always pull in master's version of the Go client. You'll need a C++ client library that matches master.
Expand Down Expand Up @@ -135,7 +135,7 @@ if err := producer.Send(context.Background(), msg); err != nil {
}
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar producer, the operation will block (waiting on a go channel) until either a producer is successfully created or an error is thrown.

Expand Down Expand Up @@ -227,7 +227,7 @@ Parameter | Description | Default
`CompressionType` | The message data compression type used by the producer. The available options are [`LZ4`](https://github.com/lz4/lz4), [`ZLIB`](https://zlib.net/), [`ZSTD`](https://facebook.github.io/zstd/) and [`SNAPPY`](https://google.github.io/snappy/). | No compression
`MessageRouter` | By default, Pulsar uses a round-robin routing scheme for [partitioned topics](cookbooks-partitioned.md). The `MessageRouter` parameter enables you to specify custom routing logic via a function that takes the Pulsar message and topic metadata as an argument and returns an integer (where the ), i.e. a function signature of `func(Message, TopicMetadata) int`. |
`Batching` | Control whether automatic batching of messages is enabled for the producer. | false
`BatchingMaxPublishDelay` | Set the time period within which the messages sent will be batched (default: 10ms) if batch messages are enabled. If set to a non zero value, messages will be queued until this time interval or until | 10ms
`BatchingMaxPublishDelay` | Set the time period within which the messages sent will be batched (default: 1ms) if batch messages are enabled. If set to a non zero value, messages will be queued until this time interval or until | 1ms
`BatchingMaxMessages` | Set the maximum number of messages permitted in a batch. (default: 1000) If set to a value greater than 1, messages will be queued until this threshold is reached or batch interval has elapsed | 1000

## Consumers
Expand Down Expand Up @@ -262,7 +262,7 @@ for cm := range msgChannel {
}
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar consumer, the operation will block (on a go channel) until either a producer is successfully created or an error is thrown.

Expand Down Expand Up @@ -368,7 +368,7 @@ reader, err := client.CreateReader(pulsar.ReaderOptions{
})
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar reader, the operation will block (on a go channel) until either a reader is successfully created or an error is thrown.

Expand Down
4 changes: 2 additions & 2 deletions site2/docs/client-libraries-go.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_label: Go
You can use Pulsar [Go client](https://github.com/apache/pulsar-client-go) to create Pulsar [producers](#producers), [consumers](#consumers), and [readers](#readers) in Go (aka Golang).

> #### API docs available as well
> **API docs available as well**
> For standard API docs, consult the [Godoc](https://godoc.org/github.com/apache/pulsar-client-go/pulsar).

Expand Down Expand Up @@ -232,7 +232,7 @@ canc()
| CompressionType | CompressionType set the compression type for the producer. | not compressed |
| MessageRouter | MessageRouter set a custom message routing policy by passing an implementation of MessageRouter | |
| DisableBatching | DisableBatching control whether automatic batching of messages is enabled for the producer. | false |
| BatchingMaxPublishDelay | BatchingMaxPublishDelay set the time period within which the messages sent will be batched | 10ms |
| BatchingMaxPublishDelay | BatchingMaxPublishDelay set the time period within which the messages sent will be batched | 1ms |
| BatchingMaxMessages | BatchingMaxMessages set the maximum number of messages permitted in a batch. | 1000 |

## Consumers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ original_id: client-libraries-go

The Pulsar Go client can be used to create Pulsar [producers](#producers), [consumers](#consumers), and [readers](#readers) in Go (aka Golang).

> #### API docs available as well
> **API docs available as well**
> For standard API docs, consult the [Godoc](https://godoc.org/github.com/apache/incubator-pulsar/pulsar-client-go/pulsar).

Expand All @@ -23,7 +23,7 @@ through [RPM](client-libraries-cpp.md#rpm), [Deb](client-libraries-cpp.md#deb) o

You can install the `pulsar` library locally using `go get`:

> #### NOTE
> **NOTE**
>
> `go get` doesn't support fetching a specific tag. so it will always pull in pulsar go client
> from latest master. You need to make sure you have installed the right pulsar cpp client library.
Expand Down Expand Up @@ -131,7 +131,7 @@ if err := producer.Send(msg); err != nil {
}
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar producer, the operation will block (waiting on a go channel) until either a producer is successfully created or an error is thrown.

Expand Down Expand Up @@ -249,7 +249,7 @@ for cm := range channel {
}
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar consumer, the operation will block (on a go channel) until either a producer is successfully created or an error is thrown.

Expand Down Expand Up @@ -338,7 +338,7 @@ reader, err := client.CreateReader(pulsar.ReaderOptions{
})
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar reader, the operation will block (on a go channel) until either a reader is successfully created or an error is thrown.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ original_id: client-libraries-go

The Pulsar Go client can be used to create Pulsar [producers](#producers), [consumers](#consumers), and [readers](#readers) in Go (aka Golang).

> #### API docs available as well
> **API docs available as well**
> For standard API docs, consult the [Godoc](https://godoc.org/github.com/apache/pulsar/pulsar-client-go/pulsar).

Expand All @@ -21,7 +21,7 @@ through [RPM](client-libraries-cpp.md#rpm), [Deb](client-libraries-cpp.md#deb) o

### Installing go package

> #### Compatibility Warning
> **Compatibility Warning**
> The version number of the Go client **must match** the version number of the Pulsar C++ client library.
You can install the `pulsar` library locally using `go get`. Note that `go get` doesn't support fetching a specific tag - it will always pull in master's version of the Go client. You'll need a C++ client library that matches master.
Expand Down Expand Up @@ -129,7 +129,7 @@ if err := producer.Send(msg); err != nil {
}
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar producer, the operation will block (waiting on a go channel) until either a producer is successfully created or an error is thrown.

Expand Down Expand Up @@ -247,7 +247,7 @@ for cm := range channel {
}
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar consumer, the operation will block (on a go channel) until either a producer is successfully created or an error is thrown.

Expand Down Expand Up @@ -336,7 +336,7 @@ reader, err := client.CreateReader(pulsar.ReaderOptions{
})
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar reader, the operation will block (on a go channel) until either a reader is successfully created or an error is thrown.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ original_id: client-libraries-go

The Pulsar Go client can be used to create Pulsar [producers](#producers), [consumers](#consumers), and [readers](#readers) in Go (aka Golang).

> #### API docs available as well
> **API docs available as well**
> For standard API docs, consult the [Godoc](https://godoc.org/github.com/apache/pulsar/pulsar-client-go/pulsar).

Expand All @@ -21,7 +21,7 @@ through [RPM](client-libraries-cpp.md#rpm), [Deb](client-libraries-cpp.md#deb) o

### Installing go package

> #### Compatibility Warning
> **Compatibility Warning**
> The version number of the Go client **must match** the version number of the Pulsar C++ client library.
You can install the `pulsar` library locally using `go get`. Note that `go get` doesn't support fetching a specific tag - it will always pull in master's version of the Go client. You'll need a C++ client library that matches master.
Expand Down Expand Up @@ -129,7 +129,7 @@ if err := producer.Send(msg); err != nil {
}
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar producer, the operation will block (waiting on a go channel) until either a producer is successfully created or an error is thrown.

Expand Down Expand Up @@ -247,7 +247,7 @@ for cm := range msgChannel {
}
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar consumer, the operation will block (on a go channel) until either a producer is successfully created or an error is thrown.

Expand Down Expand Up @@ -336,7 +336,7 @@ reader, err := client.CreateReader(pulsar.ReaderOptions{
})
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar reader, the operation will block (on a go channel) until either a reader is successfully created or an error is thrown.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ original_id: client-libraries-go

The Pulsar Go client can be used to create Pulsar [producers](#producers), [consumers](#consumers), and [readers](#readers) in Go (aka Golang).

> #### API docs available as well
> **API docs available as well**
> For standard API docs, consult the [Godoc](https://godoc.org/github.com/apache/pulsar/pulsar-client-go/pulsar).

Expand All @@ -21,7 +21,7 @@ through [RPM](client-libraries-cpp.md#rpm), [Deb](client-libraries-cpp.md#deb) o

### Installing go package

> #### Compatibility Warning
> **Compatibility Warning**
> The version number of the Go client **must match** the version number of the Pulsar C++ client library.
You can install the `pulsar` library locally using `go get`. Note that `go get` doesn't support fetching a specific tag - it will always pull in master's version of the Go client. You'll need a C++ client library that matches master.
Expand Down Expand Up @@ -129,7 +129,7 @@ if err := producer.Send(msg); err != nil {
}
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar producer, the operation will block (waiting on a go channel) until either a producer is successfully created or an error is thrown.

Expand Down Expand Up @@ -247,7 +247,7 @@ for cm := range msgChannel {
}
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar consumer, the operation will block (on a go channel) until either a producer is successfully created or an error is thrown.

Expand Down Expand Up @@ -336,7 +336,7 @@ reader, err := client.CreateReader(pulsar.ReaderOptions{
})
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar reader, the operation will block (on a go channel) until either a reader is successfully created or an error is thrown.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ original_id: client-libraries-go

The Pulsar Go client can be used to create Pulsar [producers](#producers), [consumers](#consumers), and [readers](#readers) in Go (aka Golang).

> #### API docs available as well
> **API docs available as well**
> For standard API docs, consult the [Godoc](https://godoc.org/github.com/apache/pulsar/pulsar-client-go/pulsar).

Expand All @@ -21,7 +21,7 @@ through [RPM](client-libraries-cpp.md#rpm), [Deb](client-libraries-cpp.md#deb) o

### Installing go package

> #### Compatibility Warning
> **Compatibility Warning**
> The version number of the Go client **must match** the version number of the Pulsar C++ client library.
You can install the `pulsar` library locally using `go get`. Note that `go get` doesn't support fetching a specific tag - it will always pull in master's version of the Go client. You'll need a C++ client library that matches master.
Expand Down Expand Up @@ -129,7 +129,7 @@ if err := producer.Send(msg); err != nil {
}
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar producer, the operation will block (waiting on a go channel) until either a producer is successfully created or an error is thrown.

Expand Down Expand Up @@ -247,7 +247,7 @@ for cm := range msgChannel {
}
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar consumer, the operation will block (on a go channel) until either a producer is successfully created or an error is thrown.

Expand Down Expand Up @@ -346,7 +346,7 @@ reader, err := client.CreateReader(pulsar.ReaderOptions{
})
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar reader, the operation will block (on a go channel) until either a reader is successfully created or an error is thrown.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ original_id: client-libraries-go

The Pulsar Go client can be used to create Pulsar [producers](#producers), [consumers](#consumers), and [readers](#readers) in Go (aka Golang).

> #### API docs available as well
> **API docs available as well**
> For standard API docs, consult the [Godoc](https://godoc.org/github.com/apache/pulsar/pulsar-client-go/pulsar).

Expand All @@ -21,7 +21,7 @@ through [RPM](client-libraries-cpp.md#rpm), [Deb](client-libraries-cpp.md#deb) o

### Installing go package

> #### Compatibility Warning
> **Compatibility Warning**
> The version number of the Go client **must match** the version number of the Pulsar C++ client library.
You can install the `pulsar` library locally using `go get`. Note that `go get` doesn't support fetching a specific tag - it will always pull in master's version of the Go client. You'll need a C++ client library that matches master.
Expand Down Expand Up @@ -144,7 +144,7 @@ if err := producer.Send(msg); err != nil {
}
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar producer, the operation will block (waiting on a go channel) until either a producer is successfully created or an error is thrown.

Expand Down Expand Up @@ -262,7 +262,7 @@ for cm := range msgChannel {
}
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar consumer, the operation will block (on a go channel) until either a producer is successfully created or an error is thrown.

Expand Down Expand Up @@ -414,7 +414,7 @@ reader, err := client.CreateReader(pulsar.ReaderOptions{
})
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar reader, the operation will block (on a go channel) until either a reader is successfully created or an error is thrown.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ original_id: client-libraries-go

The Pulsar Go client can be used to create Pulsar [producers](#producers), [consumers](#consumers), and [readers](#readers) in Go (aka Golang).

> #### API docs available as well
> **API docs available as well**
> For standard API docs, consult the [Godoc](https://godoc.org/github.com/apache/pulsar/pulsar-client-go/pulsar).

Expand All @@ -21,7 +21,7 @@ through [RPM](client-libraries-cpp.md#rpm), [Deb](client-libraries-cpp.md#deb) o

### Installing go package

> #### Compatibility Warning
> **Compatibility Warning**
> The version number of the Go client **must match** the version number of the Pulsar C++ client library.
You can install the `pulsar` library locally using `go get`. Note that `go get` doesn't support fetching a specific tag - it will always pull in master's version of the Go client. You'll need a C++ client library that matches master.
Expand Down Expand Up @@ -129,7 +129,7 @@ if err := producer.Send(context.Background(), msg); err != nil {
}
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar producer, the operation will block (waiting on a go channel) until either a producer is successfully created or an error is thrown.

Expand Down Expand Up @@ -221,7 +221,7 @@ Parameter | Description | Default
`CompressionType` | The message data compression type used by the producer. The available options are [`LZ4`](https://github.com/lz4/lz4), [`ZLIB`](https://zlib.net/), [`ZSTD`](https://facebook.github.io/zstd/) and [`SNAPPY`](https://google.github.io/snappy/). | No compression
`MessageRouter` | By default, Pulsar uses a round-robin routing scheme for [partitioned topics](cookbooks-partitioned.md). The `MessageRouter` parameter enables you to specify custom routing logic via a function that takes the Pulsar message and topic metadata as an argument and returns an integer (where the ), i.e. a function signature of `func(Message, TopicMetadata) int`. |
`Batching` | Control whether automatic batching of messages is enabled for the producer. | false
`BatchingMaxPublishDelay` | Set the time period within which the messages sent will be batched (default: 10ms) if batch messages are enabled. If set to a non zero value, messages will be queued until this time interval or until | 10ms
`BatchingMaxPublishDelay` | Set the time period within which the messages sent will be batched (default: 1ms) if batch messages are enabled. If set to a non zero value, messages will be queued until this time interval or until | 1ms
`BatchingMaxMessages` | Set the maximum number of messages permitted in a batch. (default: 1000) If set to a value greater than 1, messages will be queued until this threshold is reached or batch interval has elapsed | 1000

## Consumers
Expand Down Expand Up @@ -256,7 +256,7 @@ for cm := range msgChannel {
}
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar consumer, the operation will block (on a go channel) until either a producer is successfully created or an error is thrown.

Expand Down Expand Up @@ -362,7 +362,7 @@ reader, err := client.CreateReader(pulsar.ReaderOptions{
})
```

> #### Blocking operation
> **Blocking operation**
> When you create a new Pulsar reader, the operation will block (on a go channel) until either a reader is successfully created or an error is thrown.

Expand Down
Loading

0 comments on commit d5edbd9

Please sign in to comment.