Skip to content

Commit d7ffe20

Browse files
mhowlettmhowlett
authored
preparation for beta release (confluentinc#13)
* preparation for beta release * update license
1 parent bb1438a commit d7ffe20

File tree

89 files changed

+1715
-30
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

89 files changed

+1715
-30
lines changed

‎LICENSE

+213-11
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,227 @@
1-
rdkafka-dotnet - C# Apache Kafka client library
1+
Version 2.0, January 2004
2+
http://www.apache.org/licenses/
3+
4+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
5+
6+
1. Definitions.
7+
8+
"License" shall mean the terms and conditions for use, reproduction,
9+
and distribution as defined by Sections 1 through 9 of this document.
10+
11+
"Licensor" shall mean the copyright owner or entity authorized by
12+
the copyright owner that is granting the License.
13+
14+
"Legal Entity" shall mean the union of the acting entity and all
15+
other entities that control, are controlled by, or are under common
16+
control with that entity. For the purposes of this definition,
17+
"control" means (i) the power, direct or indirect, to cause the
18+
direction or management of such entity, whether by contract or
19+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
20+
outstanding shares, or (iii) beneficial ownership of such entity.
21+
22+
"You" (or "Your") shall mean an individual or Legal Entity
23+
exercising permissions granted by this License.
24+
25+
"Source" form shall mean the preferred form for making modifications,
26+
including but not limited to software source code, documentation
27+
source, and configuration files.
28+
29+
"Object" form shall mean any form resulting from mechanical
30+
transformation or translation of a Source form, including but
31+
not limited to compiled object code, generated documentation,
32+
and conversions to other media types.
33+
34+
"Work" shall mean the work of authorship, whether in Source or
35+
Object form, made available under the License, as indicated by a
36+
copyright notice that is included in or attached to the work
37+
(an example is provided in the Appendix below).
38+
39+
"Derivative Works" shall mean any work, whether in Source or Object
40+
form, that is based on (or derived from) the Work and for which the
41+
editorial revisions, annotations, elaborations, or other modifications
42+
represent, as a whole, an original work of authorship. For the purposes
43+
of this License, Derivative Works shall not include works that remain
44+
separable from, or merely link (or bind by name) to the interfaces of,
45+
the Work and Derivative Works thereof.
46+
47+
"Contribution" shall mean any work of authorship, including
48+
the original version of the Work and any modifications or additions
49+
to that Work or Derivative Works thereof, that is intentionally
50+
submitted to Licensor for inclusion in the Work by the copyright owner
51+
or by an individual or Legal Entity authorized to submit on behalf of
52+
the copyright owner. For the purposes of this definition, "submitted"
53+
means any form of electronic, verbal, or written communication sent
54+
to the Licensor or its representatives, including but not limited to
55+
communication on electronic mailing lists, source code control systems,
56+
and issue tracking systems that are managed by, or on behalf of, the
57+
Licensor for the purpose of discussing and improving the Work, but
58+
excluding communication that is conspicuously marked or otherwise
59+
designated in writing by the copyright owner as "Not a Contribution."
60+
61+
"Contributor" shall mean Licensor and any individual or Legal Entity
62+
on behalf of whom a Contribution has been received by Licensor and
63+
subsequently incorporated within the Work.
64+
65+
2. Grant of Copyright License. Subject to the terms and conditions of
66+
this License, each Contributor hereby grants to You a perpetual,
67+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
68+
copyright license to reproduce, prepare Derivative Works of,
69+
publicly display, publicly perform, sublicense, and distribute the
70+
Work and such Derivative Works in Source or Object form.
71+
72+
3. Grant of Patent License. Subject to the terms and conditions of
73+
this License, each Contributor hereby grants to You a perpetual,
74+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
75+
(except as stated in this section) patent license to make, have made,
76+
use, offer to sell, sell, import, and otherwise transfer the Work,
77+
where such license applies only to those patent claims licensable
78+
by such Contributor that are necessarily infringed by their
79+
Contribution(s) alone or by combination of their Contribution(s)
80+
with the Work to which such Contribution(s) was submitted. If You
81+
institute patent litigation against any entity (including a
82+
cross-claim or counterclaim in a lawsuit) alleging that the Work
83+
or a Contribution incorporated within the Work constitutes direct
84+
or contributory patent infringement, then any patent licenses
85+
granted to You under this License for that Work shall terminate
86+
as of the date such litigation is filed.
87+
88+
4. Redistribution. You may reproduce and distribute copies of the
89+
Work or Derivative Works thereof in any medium, with or without
90+
modifications, and in Source or Object form, provided that You
91+
meet the following conditions:
92+
93+
(a) You must give any other recipients of the Work or
94+
Derivative Works a copy of this License; and
95+
96+
(b) You must cause any modified files to carry prominent notices
97+
stating that You changed the files; and
98+
99+
(c) You must retain, in the Source form of any Derivative Works
100+
that You distribute, all copyright, patent, trademark, and
101+
attribution notices from the Source form of the Work,
102+
excluding those notices that do not pertain to any part of
103+
the Derivative Works; and
104+
105+
(d) If the Work includes a "NOTICE" text file as part of its
106+
distribution, then any Derivative Works that You distribute must
107+
include a readable copy of the attribution notices contained
108+
within such NOTICE file, excluding those notices that do not
109+
pertain to any part of the Derivative Works, in at least one
110+
of the following places: within a NOTICE text file distributed
111+
as part of the Derivative Works; within the Source form or
112+
documentation, if provided along with the Derivative Works; or,
113+
within a display generated by the Derivative Works, if and
114+
wherever such third-party notices normally appear. The contents
115+
of the NOTICE file are for informational purposes only and
116+
do not modify the License. You may add Your own attribution
117+
notices within Derivative Works that You distribute, alongside
118+
or as an addendum to the NOTICE text from the Work, provided
119+
that such additional attribution notices cannot be construed
120+
as modifying the License.
121+
122+
You may add Your own copyright statement to Your modifications and
123+
may provide additional or different license terms and conditions
124+
for use, reproduction, or distribution of Your modifications, or
125+
for any such Derivative Works as a whole, provided Your use,
126+
reproduction, and distribution of the Work otherwise complies with
127+
the conditions stated in this License.
128+
129+
5. Submission of Contributions. Unless You explicitly state otherwise,
130+
any Contribution intentionally submitted for inclusion in the Work
131+
by You to the Licensor shall be under the terms and conditions of
132+
this License, without any additional terms or conditions.
133+
Notwithstanding the above, nothing herein shall supersede or modify
134+
the terms of any separate license agreement you may have executed
135+
with Licensor regarding such Contributions.
136+
137+
6. Trademarks. This License does not grant permission to use the trade
138+
names, trademarks, service marks, or product names of the Licensor,
139+
except as required for reasonable and customary use in describing the
140+
origin of the Work and reproducing the content of the NOTICE file.
141+
142+
7. Disclaimer of Warranty. Unless required by applicable law or
143+
agreed to in writing, Licensor provides the Work (and each
144+
Contributor provides its Contributions) on an "AS IS" BASIS,
145+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
146+
implied, including, without limitation, any warranties or conditions
147+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
148+
PARTICULAR PURPOSE. You are solely responsible for determining the
149+
appropriateness of using or redistributing the Work and assume any
150+
risks associated with Your exercise of permissions under this License.
151+
152+
8. Limitation of Liability. In no event and under no legal theory,
153+
whether in tort (including negligence), contract, or otherwise,
154+
unless required by applicable law (such as deliberate and grossly
155+
negligent acts) or agreed to in writing, shall any Contributor be
156+
liable to You for damages, including any direct, indirect, special,
157+
incidental, or consequential damages of any character arising as a
158+
result of this License or out of the use or inability to use the
159+
Work (including but not limited to damages for loss of goodwill,
160+
work stoppage, computer failure or malfunction, or any and all
161+
other commercial damages or losses), even if such Contributor
162+
has been advised of the possibility of such damages.
163+
164+
9. Accepting Warranty or Additional Liability. While redistributing
165+
the Work or Derivative Works thereof, You may choose to offer,
166+
and charge a fee for, acceptance of support, warranty, indemnity,
167+
or other liability obligations and/or rights consistent with this
168+
License. However, in accepting such obligations, You may act only
169+
on Your own behalf and on Your sole responsibility, not on behalf
170+
of any other Contributor, and only if You agree to indemnify,
171+
defend, and hold each Contributor harmless for any liability
172+
incurred by, or claims asserted against, such Contributor by reason
173+
of your accepting any such warranty or additional liability.
174+
175+
END OF TERMS AND CONDITIONS
176+
177+
APPENDIX: How to apply the Apache License to your work.
178+
179+
To apply the Apache License to your work, attach the following
180+
boilerplate notice, with the fields enclosed by brackets "{}"
181+
replaced with your own identifying information. (Don't include
182+
the brackets!) The text should be enclosed in the appropriate
183+
comment syntax for the file format. We also recommend that a
184+
file or class name and description of purpose be included on the
185+
same "printed page" as the copyright notice for easier
186+
identification within third-party archives.
187+
188+
Copyright {yyyy} {name of copyright owner}
189+
190+
Licensed under the Apache License, Version 2.0 (the "License");
191+
you may not use this file except in compliance with the License.
192+
You may obtain a copy of the License at
193+
194+
http://www.apache.org/licenses/LICENSE-2.0
195+
196+
Unless required by applicable law or agreed to in writing, software
197+
distributed under the License is distributed on an "AS IS" BASIS,
198+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
199+
See the License for the specific language governing permissions and
200+
limitations under the License.
201+
202+
203+
Derived from: rdkafka-dotnet - C# Apache Kafka client library
2204

3205
Copyright (c) 2015-2016, Andreas Heider
4206
All rights reserved.
5207

6208
Redistribution and use in source and binary forms, with or without
7-
modification, are permitted provided that the following conditions are met:
209+
modification, are permitted provided that the following conditions are met:
8210

9211
1. Redistributions of source code must retain the above copyright notice,
10-
this list of conditions and the following disclaimer.
212+
this list of conditions and the following disclaimer.
11213
2. Redistributions in binary form must reproduce the above copyright notice,
12214
this list of conditions and the following disclaimer in the documentation
13-
and/or other materials provided with the distribution.
215+
and/or other materials provided with the distribution.
14216

15217
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16-
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17-
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18-
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
19-
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20-
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21-
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22-
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
218+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
219+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
220+
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
221+
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
222+
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
223+
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
224+
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23225
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24226
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25227
POSSIBILITY OF SUCH DAMAGE.

‎README.md

+30-14
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,35 @@
1-
confluent-kafka-dotnet - .NET Apache Kafka client
2-
=================================================
1+
Confluent.Kafka - Apache Kafka .NET client library
2+
==================================================
33

4-
**confluent-kafka-dotnet** is a .NET client for [Apache Kafka](http://kafka.apache.org/) based on [librdkafka](https://github.com/edenhill/librdkafka).
4+
**Confluent.Kafka** is a .NET client for [Apache Kafka](http://kafka.apache.org/) based on
5+
[librdkafka](https://github.com/edenhill/librdkafka).
56

6-
Forked from [rdkafka-dotnet](https://github.com/ah-/rdkafka-dotnet) by Andreas Heider
7+
Derived from Andreas Heider's [rdkafka-dotnet](https://github.com/ah-/rdkafka-dotnet).
78

8-
Copyright (c) 2016-2017 [Confluent Inc.](https://www.confluent.io), 2015-2017, [Andreas Heider](mailto:[email protected])
9+
*****beta quality*****
910

11+
- Only limited testing was performed
12+
- Minor API changes anticipated
13+
- Feedback encouraged
14+
15+
*****beta quality*****
1016

1117
## Usage
1218

13-
Just reference the [confluent-kafka-dotnet NuGet package](https://www.nuget.org/packages/confluent-kafka-dotnet)
19+
Reference the [Confluent.Kafka NuGet package](https://www.nuget.org/packages/Confluent.Kafka/) (version 0.9.2-beta).
20+
21+
To install Confluent.Kafka from within Visual Studio, run the following command in the Package Manager Console:
22+
23+
```
24+
Install-Package Confluent.Kafka -Pre -Version 0.9.2-beta
25+
```
26+
27+
To reference in a dotnet core project, add `"Confluent.Kafka": "0.9.2-beta"` to the dependencies section of the project.json file.
28+
29+
## Examples
30+
31+
Take a look in the [examples](examples) directory. The [integration tests](test/Confluent.Kafka.IntegrationTests/Tests) also serve as good examples.
32+
1433

1534
## Build
1635

@@ -21,26 +40,23 @@ dotnet restore
2140
dotnet build
2241
```
2342

24-
To run one of the examples, use the following from within the relevant project directory:
43+
To run an example project, run the following from within the example's project directory:
2544

2645
```
27-
dotnet run <command line args>
46+
dotnet run <args>
2847
```
2948

30-
To run the integration or unit tests, use the following from within the relevant project directory:
49+
To run the integration or unit tests, run the following from within the relevant project directory:
3150

3251
```
3352
dotnet test
3453
```
3554

36-
To create a nuget package, use the following from wihin `src/Confluent.Kafka`:
55+
To create a nuget package, run the following from wihin `src/Confluent.Kafka`:
3756

3857
```
3958
dotnet pack
4059
```
4160

42-
## Examples
43-
44-
## Documentation
4561

46-
## Supported Platforms and .NET Releases
62+
Copyright (c) 2016-2017 [Confluent Inc.](https://www.confluent.io), 2015-2016, [Andreas Heider](mailto:[email protected])

‎examples/AdvancedConsumer/Program.cs

+18
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
// Copyright 2016-2017 Confluent Inc., 2015-2016 Andreas Heider
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
//
15+
// Derived from: rdkafka-dotnet, licensed under the 2-clause BSD License.
16+
//
17+
// Refer to LICENSE for more information.
18+
119
using System;
220
using System.Collections.Generic;
321
using System.Linq;

‎examples/AdvancedProducer/Program.cs

+19
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,29 @@
1+
// Copyright 2016-2017 Confluent Inc., 2015-2016 Andreas Heider
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
//
15+
// Derived from: rdkafka-dotnet, licensed under the 2-clause BSD License.
16+
//
17+
// Refer to LICENSE for more information.
18+
119
using System;
220
using System.IO;
321
using System.Text;
422
using System.Collections.Generic;
523
using System.Threading.Tasks;
624
using Confluent.Kafka.Serialization;
725

26+
827
namespace Confluent.Kafka.Examples.AdvancedProducer
928
{
1029
public class Program

‎examples/FSharp/Program.fs

+17-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,20 @@
1-
open System
1+
// Copyright 2016-2017 Confluent Inc.
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
//
15+
// Refer to LICENSE for more information.
16+
17+
open System
218
open System.Text
319
open System.Collections.Generic
420
open Confluent.Kafka

0 commit comments

Comments
 (0)