Categorygithub.com/ivanfetch/chatserver
modulepackage
0.0.1
Repository: https://github.com/ivanfetch/chatserver.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
13
Dependents
1
Files
448 SLOC

# README

Chat Server - A Go Concurrency Learning Project

Go Reference Tests

This chat server accepts TCP connections, and allows users to broadcast messages, change their nickname, and of course, disconnect. You can connect to the chat server using a utility like netcat or telnet.

Usage

One-time Setup

Install the chat server using one of these methods:

  • Run go install github.com/ivanfetch/chatserver/cmd/chatserver@latest
  • Directly downloading a release
  • Building from source, after downloading or cloning this repository, by running make build

Example

  • Run the chat server:
$ chatserver

INFO   [0000] listening for connections on :40001 - press CTRL-c to stop the chat   server
  • Connect to the chat server, and set your nickname:
$ nc localhost 40001

Well hello there!

Anything you type will be sent to all other users of this chat server.
A line that begins with a slash (/) is considered a command - enter /help for a list of valid commands. 
-> [::1]:57715 has joined the chat
/nickname Ivan
-> "[::1]:57715" is now known as "Ivan"
Hello, to anyone else who is connected!
> Hello, to anyone else who is connected!
/quit
You're leaving? Ok - have a nice day. :)

When you are done using it, exit the chat server by pressing CTRL-c.

# Packages

No description provided by the author

# Functions

NewServer returns a *Server, including optionally specified configuration.
NewServerFromArgs returns a type *Server after processing command-line arguments.
RunCLI processes command-line arguments, instantiates a new chat server, calls ListenAndServe, waits for the chat server routines to cleanup and exit, then returns an exit status code.
RunCLIWithoutWaitingForExit processes command-line arguments, instantiates a new chat server, calls ListenAndServe, then returns an exit status code without waiting for the chat server routines to exit.
WithDebugLogging outputs debug logs to standard error.
WithListenAddress sets the corresponding field in a type Server.
WithLogWriter sets the io.Writer where log output is written.

# Variables

Populated at build time.
Populated at build time.

# Structs

Server holds the TCP listener, configuration, and communication channels used by goroutines.

# Type aliases

ServerOption uses a function to set fields on a type Server by operating on that type as an argument.