Skip to content

Commit

Permalink
Fix typo in port option docs (#80)
Browse files Browse the repository at this point in the history
* Fix typo in port option docs

* Update port documentation

---------

Co-authored-by: Mat Trudel <[email protected]>
  • Loading branch information
aaronrenner and mtrudel authored Sep 15, 2023
1 parent 64c7aef commit a396029
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion lib/thousand_island.ex
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,8 @@ defmodule ThousandIsland do
underlying `GenServer.start_link/3` call. Optional, defaulting to []
* `port`: The TCP port number to listen on. If not specified this defaults to 4000.
If a port number of `0` is given, the server will dynamically assign a port number
which can then be obtained via `sockname/1`
which can then be obtained via `ThousandIsland.listener_info/1` or
`ThousandIsland.Socket.sockname/1`
* `transport_module`: The name of the module which provides basic socket functions.
Thousand Island provides `ThousandIsland.Transports.TCP` and `ThousandIsland.Transports.SSL`,
which provide clear and TLS encrypted TCP sockets respectively. If not specified this
Expand Down

0 comments on commit a396029

Please sign in to comment.