Rename from telnetd to telnet

Author: nomis

.travis.yml

@@ -26,4 +26,4 @@ script:
 notifications:
   email:
     recipients:
-      - secure: "zqWXLdR9ZJph67wOOkQ7fRW6BY5ZI0hSyn6uwwGYsKq185qBWHOa/2CD0l83hpRj34AYyGdYqbtjC78FIvB0ZcJZuXsqfGjlNtmU3VEp5eZcYfY/mBIuA3GpxIhbF+QFJblLqcj/40y/2om1ICvzQLHITiXMk5o27AHWgR5qbFzO5afSmzNgmV2CEpahI6v3FqPa+L55kNtv2NggpJUrRqsZgAsny9EbiVH0Xt03C1nK9Xem9PbP5XSYPJaIi6vxfZKjaSnffsSj6QHR6fOsWpeYMxscaWlh2ZGRsK6yrAq5XAD/5QO8ZEG6up/m35DrRsaKKYUNemT3xDaaRE+KojR1CI2r0++C8Y0htfexji++xEeRs3IXtIMVUsYxaG5R5wH4nQQ5I0kHkaLsy0lp4nlTBBBP+MNGYuPwPcT26cRRS0OtDmGD9mKVEGJdA/y5YQo4COGlEwO/nTADOUwP8koN1GpPioONjMYn/tDIaXLUaRaxqKzmzryRyJwRX2N8da/s4/p/bHaOv8CdvRj56yC0AKitcxkO4XfFqYhm9IYxW6JkDF5n7DhiYmjC0ISoqiDZp6dV24dGjHYta+J/GqRTGvjr00aAATDW3TteOPOXJxLR3sRWN+on/K55OCN+vY1HrqxV18SzYRVqf1v6JLSQ+T59i5H5Su5+bGBTlwc="
+      - secure: "vsmdztqdhvF9aYlZ7j3whGFcOqlewwmIHCBiUYsIY8xRPj9W1bznct3g+D7A4Q+3Yvfi3Ag32cZT/e2aMquAygPhkVPbkBLAJrRpj1UPtk6nSk9WgeNJ4SiO8xjB6XAAV4kAJxeVLCbtOqNX+ifDmfDEdAuDiCNUzswe5fq7SVXvV9LHhDXvj4hHtfwMRYIYi2lRDMVvH//zIjMee7sj5Xqr1Y5d/hm2s/hffKFr0pSy3o45aI4De1Gkum91Rr464k3dcp9lArsKN2DsdllqA5xoGT4GQiGDeWr1fZKt1DDN7bvMWlun6hHSMI+IOyXF/uxzsKXrIq7X4d1txRDT2LeAcEyA+YdvMsViXPs8hEeKDWBkbMnAxbKbgDKAhu71J0RS5atTlVic+6sGwas5fE9i54jDstlJU0Bg6AZBZextEkjzU8RLHs6jSbQNYXcVV0tWGt9/ciIU9VBMoDIoXeteeZ13aWvDNXX6w/WT+78uaGjh6KLQC+DNoN0aYsAbWWRuFEgVHPw24nTJIa6HIf8+FnR6rFBCII2yI1PRMEbKrdSWRAK7Oi+5dBvqbbPXIRF3hY1hgYu9rN8/nywv2/dXgahHyW0kgtmONbWK8udLDCT9ofp78FWoTq0mZFf1WtGUcWdnUpBN+7Q3Uaq1rH7fe6D90aG/qTkzp1rTYlk="

README.rst

@@ -1,5 +1,5 @@
-mcu-uuid-telnetd |Build Status|
-===============================
+mcu-uuid-telnet |Build Status|
+==============================
 
 Description
 -----------
@@ -15,10 +15,10 @@ Provides access to a console shell as a telnet server (using the
 Documentation
 -------------
 
-`Read the documentation <https://mcu-uuid-telnetd.readthedocs.io/>`_
+`Read the documentation <https://mcu-uuid-telnet.readthedocs.io/>`_
 generated from the docs_ directory.
 
 .. _docs: docs/
 
-.. |Build Status| image:: https://travis-ci.org/nomis/mcu-uuid-telnetd.svg?branch=master
-   :target: https://travis-ci.org/nomis/mcu-uuid-telnetd
+.. |Build Status| image:: https://travis-ci.org/nomis/mcu-uuid-telnet.svg?branch=master
+   :target: https://travis-ci.org/nomis/mcu-uuid-telnet

docs/changelog.rst

@@ -20,5 +20,5 @@ Added
 
 .. |--| unicode:: U+2013 .. EN DASH
 
-.. _Unreleased: https://github.com/nomis/mcu-uuid-telnetd/compare/0.1.0...HEAD
-.. _0.1.0: https://github.com/nomis/mcu-uuid-telnetd/commits/0.1.0
+.. _Unreleased: https://github.com/nomis/mcu-uuid-telnet/compare/0.1.0...HEAD
+.. _0.1.0: https://github.com/nomis/mcu-uuid-telnet/commits/0.1.0

docs/conf.py

@@ -8,7 +8,7 @@
 extensions = []
 source_suffix = ['.rst']
 
-project = u'mcu-uuid-telnetd'
+project = u'mcu-uuid-telnet'
 copyright = u'2019, Simon Arlott'
 author = u'Simon Arlott'
 

docs/index.rst

@@ -1,5 +1,5 @@
-mcu-uuid-telnetd
-================
+mcu-uuid-telnet
+===============
 
 Description
 -----------
@@ -36,8 +36,8 @@ Resources
    :titlesonly:
    :maxdepth: 1
 
-   Source code <https://github.com/nomis/mcu-uuid-telnetd>
-   Releases <https://github.com/nomis/mcu-uuid-telnetd/releases>
-   Namespace reference <https://mcu-doxygen.uuid.uk/namespaceuuid_1_1telnetd.html>
+   Source code <https://github.com/nomis/mcu-uuid-telnet>
+   Releases <https://github.com/nomis/mcu-uuid-telnet/releases>
+   Namespace reference <https://mcu-doxygen.uuid.uk/namespaceuuid_1_1telnet.html>
    changelog
-   Issue tracker <https://github.com/nomis/mcu-uuid-telnetd/issues>
+   Issue tracker <https://github.com/nomis/mcu-uuid-telnet/issues>

docs/usage.rst

@@ -3,9 +3,9 @@ Usage
 
 .. code:: c++
 
-   #include <uuid/telnetd.h>
+   #include <uuid/telnet.h>
 
-Create a |uuid::telnetd::TelnetService|_ and call |start()|_.
+Create a |uuid::telnet::TelnetService|_ and call |start()|_.
 
 Call |loop()|_ regularly and when WiFi connectivity is available
 connections will be accepted.
@@ -23,14 +23,14 @@ Example
 
 .. literalinclude:: ../examples/DigitalIO.cpp
 
-.. |uuid::telnetd::TelnetService| replace:: ``uuid::telnetd::TelnetService``
-.. _uuid::telnetd::TelnetService: https://mcu-doxygen.uuid.uk/classuuid_1_1telnetd_1_1TelnetService.html
+.. |uuid::telnet::TelnetService| replace:: ``uuid::telnet::TelnetService``
+.. _uuid::telnet::TelnetService: https://mcu-doxygen.uuid.uk/classuuid_1_1telnet_1_1TelnetService.html
 
 .. |start()| replace:: ``start()``
-.. _start(): https://mcu-doxygen.uuid.uk/classuuid_1_1telnetd_1_1TelnetService.html#aa3f64dc0c3b0b8f561c004bdeb5dbcb7
+.. _start(): https://mcu-doxygen.uuid.uk/classuuid_1_1telnet_1_1TelnetService.html#aa3f64dc0c3b0b8f561c004bdeb5dbcb7
 
 .. |loop()| replace:: ``loop()``
-.. _loop(): https://mcu-doxygen.uuid.uk/classuuid_1_1telnetd_1_1TelnetService.html#ab08b97b1afc1a8c82de5fe7dac0d890e
+.. _loop(): https://mcu-doxygen.uuid.uk/classuuid_1_1telnet_1_1TelnetService.html#ab08b97b1afc1a8c82de5fe7dac0d890e
 
 .. |uuid::console::Shell::loop_all()| replace:: ``uuid::console::Shell::loop_all()``
 .. _uuid::console::Shell::loop_all(): https://mcu-doxygen.uuid.uk/classuuid_1_1console_1_1Shell.html#affe5b4812696a9a53eed1f394301354e

examples/DigitalIO.cpp

@@ -11,15 +11,15 @@
 
 #include <uuid/common.h>
 #include <uuid/console.h>
-#include <uuid/telnetd.h>
+#include <uuid/telnet.h>
 
 using uuid::read_flash_string;
 using uuid::flash_string_vector;
 using uuid::console::Commands;
 using uuid::console::Shell;
 
 static std::shared_ptr<Commands> commands = std::make_shared<Commands>();
-static uuid::telnetd::TelnetService telnet{commands};
+static uuid::telnet::TelnetService telnet{commands};
 
 void setup() {
 	commands->add_command(flash_string_vector{F("pinMode")},

src/stream.cpp

@@ -1,5 +1,5 @@
 /*
- * uuid-telnetd - Telnet service
+ * uuid-telnet - Telnet service
  * Copyright 2019  Simon Arlott
  *
  * This program is free software: you can redistribute it and/or modify
@@ -16,7 +16,7 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "uuid/telnetd.h"
+#include "uuid/telnet.h"
 
 #include <Arduino.h>
 
@@ -26,7 +26,7 @@
 
 namespace uuid {
 
-namespace telnetd {
+namespace telnet {
 
 TelnetStream::TelnetStream(WiFiClient &client)
 		: client_(client) {
@@ -353,6 +353,6 @@ size_t TelnetStream::raw_write(const uint8_t *buffer, size_t size) {
 	return size;
 }
 
-} // namespace telnetd
+} // namespace telnet
 
 } // namespace fridge

src/telnetd.cpp renamed to src/telnet.cpp

@@ -1,5 +1,5 @@
 /*
- * uuid-telnetd - Telnet service
+ * uuid-telnet - Telnet service
  * Copyright 2019  Simon Arlott
  *
  * This program is free software: you can redistribute it and/or modify
@@ -16,7 +16,7 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "uuid/telnetd.h"
+#include "uuid/telnet.h"
 
 #include <Arduino.h>
 #ifdef ARDUINO_ARCH_ESP8266
@@ -34,35 +34,35 @@
 #include <uuid/common.h>
 #include <uuid/log.h>
 
-#ifndef UUID_TELNETD_HAVE_WIFICLIENT_REMOTE
+#ifndef UUID_TELNET_HAVE_WIFICLIENT_REMOTE
 # if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32)
-#  define UUID_TELNETD_HAVE_WIFICLIENT_REMOTE 1
+#  define UUID_TELNET_HAVE_WIFICLIENT_REMOTE 1
 # else
-#  define UUID_TELNETD_HAVE_WIFICLIENT_REMOTE 0
+#  define UUID_TELNET_HAVE_WIFICLIENT_REMOTE 0
 # endif
 #endif
 
-#ifndef UUID_TELNETD_HAVE_WIFICLIENT_NODELAY
+#ifndef UUID_TELNET_HAVE_WIFICLIENT_NODELAY
 # if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32)
-#  define UUID_TELNETD_HAVE_WIFICLIENT_NODELAY 1
+#  define UUID_TELNET_HAVE_WIFICLIENT_NODELAY 1
 # else
-#  define UUID_TELNETD_HAVE_WIFICLIENT_NODELAY 0
+#  define UUID_TELNET_HAVE_WIFICLIENT_NODELAY 0
 # endif
 #endif
 
-#ifndef UUID_TELNETD_HAVE_WIFICLIENT_KEEPALIVE
+#ifndef UUID_TELNET_HAVE_WIFICLIENT_KEEPALIVE
 # if defined(ARDUINO_ARCH_ESP8266)
-#  define UUID_TELNETD_HAVE_WIFICLIENT_KEEPALIVE 1
+#  define UUID_TELNET_HAVE_WIFICLIENT_KEEPALIVE 1
 # else
-#  define UUID_TELNETD_HAVE_WIFICLIENT_KEEPALIVE 0
+#  define UUID_TELNET_HAVE_WIFICLIENT_KEEPALIVE 0
 # endif
 #endif
 
-static const char __pstr__logger_name[] __attribute__((__aligned__(sizeof(int)))) PROGMEM = "telnetd";
+static const char __pstr__logger_name[] __attribute__((__aligned__(sizeof(int)))) PROGMEM = "telnet";
 
 namespace uuid {
 
-namespace telnetd {
+namespace telnet {
 
 uuid::log::Logger TelnetService::logger_{FPSTR(__pstr__logger_name), uuid::log::Facility::DAEMON};
 
@@ -152,19 +152,19 @@ void TelnetService::loop() {
 	WiFiClient client = server_.available();
 	if (client) {
 		if (connections_.size() >= maximum_connections_) {
-#if UUID_TELNETD_HAVE_WIFICLIENT_REMOTE
+#if UUID_TELNET_HAVE_WIFICLIENT_REMOTE
 			logger_.info(F("New connection from [%s]:%u rejected (connection limit reached)"),  uuid::printable_to_string(client.remoteIP()).c_str(), client.remotePort());
 #else
 			logger_.info(F("New connection rejected (connection limit reached)"));
 #endif
 			client.println(F("Maximum connection limit reached."));
 			client.stop();
 		} else {
-#if UUID_TELNETD_HAVE_WIFICLIENT_REMOTE
+#if UUID_TELNET_HAVE_WIFICLIENT_REMOTE
 			logger_.info(F("New connection from [%s]:%u accepted"), uuid::printable_to_string(client.remoteIP()).c_str(), client.remotePort());
 #endif
 			connections_.emplace_back(shell_factory_, std::move(client), initial_idle_timeout_, write_timeout_);
-#if !(UUID_TELNETD_HAVE_WIFICLIENT_REMOTE)
+#if !(UUID_TELNET_HAVE_WIFICLIENT_REMOTE)
 			logger_.info(F("New connection %p accepted"), &connections_.back());
 #endif
 		}
@@ -173,19 +173,19 @@ void TelnetService::loop() {
 
 TelnetService::Connection::Connection(shell_factory_function &shell_factory, WiFiClient &&client, unsigned long idle_timeout, unsigned long write_timeout)
 		: client_(std::move(client)), stream_(client_) {
-#if UUID_TELNETD_HAVE_WIFICLIENT_REMOTE
+#if UUID_TELNET_HAVE_WIFICLIENT_REMOTE
 	// These have to be copied because they're not accessible on closed connections
 	addr_ = client_.remoteIP();
 	port_ = client_.remotePort();
 #else
 	port_ = 0;
 #endif
 
-#if UUID_TELNETD_HAVE_WIFICLIENT_NODELAY
+#if UUID_TELNET_HAVE_WIFICLIENT_NODELAY
 	client_.setNoDelay(true);
 #endif
 
-#if UUID_TELNETD_HAVE_WIFICLIENT_KEEPALIVE
+#if UUID_TELNET_HAVE_WIFICLIENT_KEEPALIVE
 	// Disconnect after 30 seconds without a response
 	client_.keepAlive(5, 5, 5);
 #endif
@@ -217,7 +217,7 @@ bool TelnetService::Connection::loop() {
 		}
 		return true;
 	} else {
-#if UUID_TELNETD_HAVE_WIFICLIENT_REMOTE
+#if UUID_TELNET_HAVE_WIFICLIENT_REMOTE
 		logger_.info(F("Connection from [%s]:%u closed"), uuid::printable_to_string(addr_).c_str(), port_);
 #else
 		logger_.info(F("Connection %p closed"), this);
@@ -232,6 +232,6 @@ void TelnetService::Connection::stop() {
 	}
 }
 
-} // namespace telnetd
+} // namespace telnet
 
 } // namespace fridge

src/uuid/telnetd.h renamed to src/uuid/telnet.h

@@ -1,5 +1,5 @@
 /*
- * uuid-telnetd - Telnet service
+ * uuid-telnet - Telnet service
  * Copyright 2019  Simon Arlott
  *
  * This program is free software: you can redistribute it and/or modify
@@ -16,8 +16,8 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef UUID_TELNETD_H_
-#define UUID_TELNETD_H_
+#ifndef UUID_TELNET_H_
+#define UUID_TELNET_H_
 
 #include <Arduino.h>
 #ifdef ARDUINO_ARCH_ESP8266
@@ -40,10 +40,10 @@ namespace uuid {
 /**
  * Telnet service.
  *
- * - <a href="https://github.com/nomis/mcu-uuid-telnetd/">Git Repository</a>
- * - <a href="https://mcu-uuid-telnetd.readthedocs.io/">Documentation</a>
+ * - <a href="https://github.com/nomis/mcu-uuid-telnet/">Git Repository</a>
+ * - <a href="https://mcu-uuid-telnet.readthedocs.io/">Documentation</a>
  */
-namespace telnetd {
+namespace telnet {
 
 /**
  * Stream wrapper that performs telnet protocol handling, option
@@ -434,7 +434,7 @@ class TelnetService {
 	unsigned long write_timeout_ = DEFAULT_WRITE_TIMEOUT; /*!< Write timeout (in milliseconds). @since 0.1.0 */
 };
 
-} // namespace telnetd
+} // namespace telnet
 
 } // namespace uuid