tcp-streams

One stop solution for tcp client and server with tls support. https://github.com/didi-FP/tcp-streams

Version on this page:0.6.0.0
LTS Haskell 8.3:0.6.0.0
Stackage Nightly 2017-02-26:0.6.0.0
Latest on Hackage:1.0.0.0
BSD3 licensed by winterland1989
Maintained by winterland1989@gmail.com

Module documentation for 0.6.0.0

tcp-streams

Hackage Build Status

One stop solution for tcp client and server with tls support!

  • use io-streams for auto read buffering and easy streamming process.

  • use tls for tls connection.

Built-in mozilla CA list date: 2017/01/18.

From v0.6 TLS using HsOpenSSL is split into tcp-streams-openssl due to the difficulties of setting up openssl on many platform.

Also take a look at wire-stream, for serialize/deserialize data. Happy hacking!

Example

import           Data.Connection
import qualified System.IO.Streams.TCP     as TCP
import qualified Data.TLSSetting           as TLS
import qualified System.IO.Streams.TLS     as TLS

--  TCP Client
...
conn <- TCP.connect "127.0.0.1" 8888
send conn "Hello! World." ..  -- sending
res <- Stream.read (source conn) ..  -- receiving
close conn                ..  -- closing
...


-- TCP Server
...
sock <- TCP.bindAndListen 1024 8888
conn <- TCP.accept sock
req <- Stream.read (source conn) ..   -- receiving
send conn "GoodBye!" ..  -- sending
...


--  TLS Client
...
cp <- TLS.makeTLSClientParams (TLS.CustomCAStore "myCA.pem")
conn <- TLS.connect cp (Just "myCAName") "127.0.0.1" 8888
...


--  TLS Server
...
sp <- TLS.makeServerParams "server.crt" [] "server.key"
sock <- TCP.bindAndListen 1024 8889
conn <- TLS.accept sp sock
...


-- HTTPS Client
...
cp <- TLS.makeClientParams TLS.MozillaCAStore
conn <- TLS.connect cp Nothing "www.google.com" 443
send conn "GET / HTTP/1.1\r\n"
send conn "Host: www.google.com\r\n"
send conn "\r\n"
bs <- Stream.readExactly 1024 (source conn)
...

License

Copyright (c) 2016, Winterland

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the following
  disclaimer in the documentation and/or other materials provided
  with the distribution.

* Neither the name of winterland1989 nor the names of other
  contributors may be used to endorse or promote products derived
  from this software without specific prior written permission.

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

Changes

Revision history for tcp-streams

1.0.0.0

Major rewrite using new Connection interface.

  • Introduce Connection in Data.Connection to leaverage vectorized IO.
  • Now connect, accept return Connection, remove withXXX functions.
  • Change exception behavior to work better with bracket.
  • bindAndListen 's type changed from PortNumber -> Int -> IO Socket to Int -> PortNumber -> IO Socket.
  • Add bindAndListenWith for custom socket options.
  • Add unix domain socket support.
  • Update built-in mozilla CA list(2017/01/18).

0.7.0.0

  • Add built-in timeout support
  • Change behavior using io-streams' convention:
    • reading InputStream will throw exception, and the socket won't be closed.
    • writing to OutputStream will not cause a write until flush.
    • writing empty ByteString to OutputStream will do a flush.

0.6.0.0

0.5.0.0

  • Update built-in mozilla CA list(2016/09/14).
  • Export Data.TLSSetting from System.IO.Streams.TLS, and Data.OpenSSLSetting from System.IO.Streams.OpenSSL.

0.4.0.0

  • Auto add withOpenSSL.
  • Add extra-libraries to cabal file.

0.3.0.0

  • Add qualified notes, rename closeTLS/closeSSL to close.
  • Fix Bad pipe error in tls's close

0.2.3.0

  • Add acceptWithBufferSize, socketToStreamsWithBufferSize, fix recv exception handler.

0.2.2.0

  • Clean and document exception behavior.

0.2.1.0

  • Fix broken document.

0.2.0.0

  • Add support for openssl using HsOpenSSL package.

0.1.0.0

  • First version. Released on an unsuspecting world.
comments powered byDisqus