Skip to content

Commit 42d3dee

Browse files
author
John Gozde
committed
Add readme, license and authors files.
1 parent 51734c8 commit 42d3dee

File tree

5 files changed

+356
-1
lines changed

5 files changed

+356
-1
lines changed

‎AUTHORS

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Jeffrey Dik
2+
Martin Sustrik github.com/sustrik
3+
Michael Compton
4+
John Gozde github.com/jgoz
5+
Rui Lopes github.com/rgl
6+
Fredrik Holmstr�m github.com/fholm
7+
ckobra github.com/ckobra

‎LICENSE

+165
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

‎README

Whitespace-only changes.

‎README.md

+181
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
# clrzmq &mdash; Official 0MQ Bindings for .NET and Mono
2+
*(Formerly clrzmq2; legacy bindings have moved to [clrzmq-old][clrzmq-old])*
3+
4+
This project aims to provide the full functionality of the underlying ZeroMQ API to CLR projects. The version of libzmq currently being targeted is **2.1 (stable)**.
5+
6+
## Getting Started
7+
8+
The quickest way to get started with clrzmq is by using the [NuGet package][clrzmq-nuget-x86] ([64-bit version][clrzmq-nuget-x64]). The NuGet packages include a copy of the native libzmq.dll, which is required to use clrzmq.
9+
10+
You may also build clrzmq directly from the source. See the Development Environment Setup instructions below for more detail.
11+
12+
To get an idea of how to use clrzmq, have a look at the following example.
13+
14+
### Example server
15+
16+
```c#
17+
using System;
18+
using System.Text;
19+
using System.Threading;
20+
using ZMQ;
21+
22+
namespace ZMQGuide
23+
{
24+
class Program
25+
{
26+
static void Main(string[] args)
27+
{
28+
// ZMQ Context, server socket
29+
using (Context context = new Context(1)
30+
using (Socket socket = context.Socket(SocketType.REP))
31+
{
32+
socket.Bind("tcp://*:5555");
33+
34+
while (true)
35+
{
36+
// Wait for next request from client
37+
string message = socket.Recv(Encoding.Unicode);
38+
Console.WriteLine("Received request: {0}", message);
39+
40+
// Do Some 'work'
41+
Thread.Sleep(1000);
42+
43+
// Send reply back to client
44+
socket.Send("World", Encoding.Unicode);
45+
}
46+
}
47+
}
48+
}
49+
}
50+
51+
### Example client
52+
53+
```c#
54+
using System;
55+
using System.Text;
56+
using ZMQ;
57+
58+
namespace ZMQGuide
59+
{
60+
class Program
61+
{
62+
static void Main(string[] args)
63+
{
64+
// ZMQ Context and client socket
65+
using (Context context = new Context(1))
66+
using (Socket requester = context.Socket(SocketType.REQ))
67+
{
68+
requester.Connect("tcp://localhost:5555");
69+
70+
string request = "Hello";
71+
for (int requestNum = 0; requestNum < 10; requestNum++)
72+
{
73+
Console.WriteLine("Sending request {0}...", requestNum);
74+
requester.Send(request, Encoding.Unicode);
75+
76+
string reply = requester.Recv(Encoding.Unicode);
77+
Console.WriteLine("Received reply {0}: {1}", requestNum, reply);
78+
}
79+
}
80+
}
81+
}
82+
}
83+
```
84+
85+
More C# examples can be found in the [0MQ Guide][zmq-guide] or in the [examples repository][zmq-example-repo]. Tutorials and API documentation specific to clrzmq are on the way.
86+
87+
## Development Environment
88+
89+
On Windows/.NET, clrzmq is developed with Visual Studio 2010. Mono development is done with MonoDevelop 2.8+.
90+
91+
### Windows/.NET
92+
93+
Before clrzmq can be used, the native `libzmq.dll` must be compiled for your target platform from [0MQ sources][libzmq-2].
94+
95+
#### libzmq
96+
97+
1. Download/clone the source from the [repository][libzmq-2] or the [ZeroMQ website][zmq-dl].
98+
2. Open the Visual Studio solution, located in `builds/msvc/msvc.sln`.
99+
3. Set the build configuration as necessary (e.g., Release/Win32 or WithOpenPGM/x64).
100+
* **NOTE:** WithOpenPGM builds require the bundled OpenPGM sources to be built for Windows, the steps of which are beyond the scope of this README.
101+
4. Build the `libzmq` project.
102+
5. `libzmq.dll` should now be located at `/lib` in the zeromq source tree.
103+
104+
#### clrzmq
105+
106+
1. Clone the source.
107+
2. Run `nuget.cmd`, which downloads any dependent packages (e.g., Machine.Specifications for acceptance tests).
108+
3. Copy `libzmq.dll` from the zeromq project to the appropriate location in the clrzmq lib folder (i.e., `/lib/x86` or `/lib/x64`).
109+
4. Run `build.cmd` to build the project and run the test suite. PGM-related tests will fail if a non-PGM build of libzmq is used.
110+
5. The resulting binaries will be available in `/out`.
111+
112+
### Mono
113+
114+
**NOTE**: Mono 2.10.7+ is required **for development only**, as the NuGet scripts and executables require this version to be present.
115+
If you choose to install dependencies manually, you may use any version of Mono 2.6+.
116+
117+
#### Mono 2.10.7+ configuration
118+
119+
NuGet relies on several certificates to be registered with Mono. The following is an example terminal session (on Ubuntu) for setting this up correctly.
120+
This assumes you have already installed Mono 2.10.7 or higher.
121+
122+
```shell
123+
$ mozroots --import
124+
... typing 'yes' many, many times...
125+
126+
$ certmgr -ssl https://go.microsoft.com
127+
$ certmgr -ssl https://nugetgallery.blob.core.windows.net
128+
$ certmgr -ssl https://nuget.org
129+
```
130+
131+
With any luck, this is the correct set of certificates to get NuGet working on Mono.
132+
133+
#### libzmq
134+
135+
Either clone the [ZeroMQ repository][libzmq-2] or [download the sources][zmq-dl], and then follow the build/install instructions for your platform.
136+
Use the `--with-pgm` option if possible.
137+
138+
#### clrzmq
139+
140+
1. Clone the source.
141+
2. Run `nuget.sh`, which downloads any dependent packages (e.g., Machine.Specifications for acceptance tests).
142+
3. Run `build.sh` to build the project and run the test suite. PGM-related tests will fail if a non-PGM build of libzmq is used.
143+
4. The resulting binaries will be available in `/out`.
144+
145+
## Issues
146+
147+
Issues should be logged on the [GitHub issue tracker][issues] for this project.
148+
149+
When reporting issues, please include the following information if possible:
150+
151+
* Version of clrzmq and/or how it was obtained (compiled from source, NuGet package)
152+
* Version of libzmq being used
153+
* Runtime environment (.NET/Mono and associated version)
154+
* Operating system and platform (Win7/64-bit, Linux/32-bit)
155+
* Code snippet demonstrating the failure
156+
157+
## Contributing
158+
159+
Pull requests and patches are always appreciated! To speed up the merge process, please follow the guidelines below when making a pull request:
160+
161+
* Create a new branch in your fork for the changes you intend to make. Working directly in master can often lead to unintended additions to the pull request later on.
162+
* When appropriate, add to the AcceptanceTests project to cover any new functionality or defect fixes.
163+
* Ensure all previous tests continue to pass (with exceptions for PGM tests)
164+
* Follow the code style used in the rest of the project. ReSharper and StyleCop configurations have been included in the source tree.
165+
166+
Pull requests will still be accepted if some of these guidelines are not followed: changes will just take longer to merge, as the missing pieces will need to be filled in.
167+
168+
## License
169+
170+
This project is released under the [LGPL][lgpl] license, as is the native libzmq library. See LICENSE for more details as well as the [0MQ Licensing][zmq-license] page.
171+
172+
[clrzmq-old]: https://github.com/zeromq/clrzmq-old
173+
[clrzmq-nuget-x86]: http://packages.nuget.org/Packages/clrzmq
174+
[clrzmq-nuget-x64]: http://packages.nuget.org/Packages/clrzmq-x64
175+
[libzmq-2]: https://github.com/zeromq/zeromq2-1
176+
[zmq-guide]: http://zguide.zeromq.org/page:all
177+
[zmq-example-repo]: https://github.com/imatix/zguide/tree/master/examples/C%23
178+
[zmq-dl]: http://www.zeromq.org/intro:get-the-software
179+
[zmq-license]: http://www.zeromq.org/area:licensing
180+
[issues]: https://github.com/zeromq/clrzmq/issues
181+
[lgpl]: http://www.gnu.org/licenses/lgpl.html

‎clrzmq.sln

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ Microsoft Visual Studio Solution File, Format Version 11.00
33
# Visual Studio 2010
44
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{1C71420E-3277-4855-A266-E50593D8164D}"
55
ProjectSection(SolutionItems) = preProject
6-
README = README
6+
AUTHORS = AUTHORS
7+
LICENSE = LICENSE
8+
README.md = README.md
79
EndProjectSection
810
EndProject
911
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "settings", "settings", "{F931F059-9877-4554-85E6-771DFECDFE00}"

0 commit comments

Comments
 (0)