{"header":{"message":"Add a placeholder echo TCP service.","description":null,"timestamp":"2022-08-08T20:44:32.7268128Z","authors":[{}]},"hash":"NYYW4ZOQX75F3WRHJYRDIKKCHTNQSSM6QZFLJC6JKZUM4AAZXYDAC","authors":[{"login":"mvarjon","key":"BmtceA6r9wJnMV6vSg14Vz97AmUdThh226FwF1GeXMqC"}],"deps":{"hashes":[["NYYW4ZOQX75F3WRHJYRDIKKCHTNQSSM6QZFLJC6JKZUM4AAZXYDAC","Add a placeholder echo TCP service."],["AA",null],["HIIO3QARO32NKUZOLZCCUPQUDWTSBFTROOMPQRWMOBNZNOUGRQRAC","Fix cargo clippy errors and prepare for initial networking implementation."],["IX73DI3JJBWPP7NDCWXD6OFZVHC6LPEMEWUGLAO2W3DW2UZPDLNAC","Setup logging infrastructure."],["EQDUMQSNRCJGYQZL4M6GODYKUG2UMO4G5VWESE6DK4BMWJKGC3HQC","Basic high level architecture draft."],["WZU7DT3XXIH4WXNZEHZJBTW6PUMQDTHAUIX7EGV6NZYPZXUJU3GQC","Handle Ctrl+C from terminal."],["DBEJ4WF23FBK5QPXENXCT6P43JBJQU36RGYMQT5CAA53EZUCW7VQC","Abstract the stop conditions coming from OS."],["BJZD3LYFA77H5MPFKDBVXK3YE5OCL4T4KWRKFM67SZTA6UHRUNGQC","Skeleton for server implementation."],["FPX4JMCJTVSWMV76OY5NIZ6IOZ4GGNLGAX5J43EBBHR3XRXTLMWAC","Implement UNIX signal receiver for controlled shutdown."]],"deps":["HIIO3QARO32NKUZOLZCCUPQUDWTSBFTROOMPQRWMOBNZNOUGRQRAC"],"known":["EQDUMQSNRCJGYQZL4M6GODYKUG2UMO4G5VWESE6DK4BMWJKGC3HQC","BJZD3LYFA77H5MPFKDBVXK3YE5OCL4T4KWRKFM67SZTA6UHRUNGQC","IX73DI3JJBWPP7NDCWXD6OFZVHC6LPEMEWUGLAO2W3DW2UZPDLNAC","WZU7DT3XXIH4WXNZEHZJBTW6PUMQDTHAUIX7EGV6NZYPZXUJU3GQC","DBEJ4WF23FBK5QPXENXCT6P43JBJQU36RGYMQT5CAA53EZUCW7VQC","FPX4JMCJTVSWMV76OY5NIZ6IOZ4GGNLGAX5J43EBBHR3XRXTLMWAC"]},"hunks":[{"Replacement":{"inode":{"change":3,"pos":40},"path":"src/signal_guard.rs","line":1,"ins":{"up_context":[{"change":3,"pos":40}],"down_context":[],"flag":"BLOCK","start":0,"end":2856,"inode":{"change":3,"pos":40}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":40},"to":{"change":2,"start":0,"end":2856},"introduced_by":2}],"inode":{"change":3,"pos":40}},"ins_contents":[{"Add":"use futures::prelude::*;"},{"Add":"use futures::stream::FuturesUnordered;"},{"Add":"use log::info;"},{"Add":"use std::collections::HashMap;"},{"Add":"use tokio::signal::unix::{signal, SignalKind};"},{"Add":"use tokio::sync::broadcast::Sender;"},{"Add":""},{"Add":"pub struct SignalGuard {}"},{"Add":""},{"Add":"impl SignalGuard {"},{"Add":" pub async fn wait_for_stop(signal_forwarder: &Sender) -> Option<()> {"},{"Add":" // Default behavior in UNIX is to terminate process when any of the"},{"Add":" // following signals are received. In each of these case we initiate"},{"Add":" // the controlled shutdown."},{"Add":" let mut interrupt_stream = signal(SignalKind::interrupt()).ok()?;"},{"Add":" let mut terminate_stream = signal(SignalKind::terminate()).ok()?;"},{"Add":" let mut alarm_stream = signal(SignalKind::alarm()).ok()?;"},{"Add":" let mut hangup_stream = signal(SignalKind::hangup()).ok()?;"},{"Add":" let mut quit_stream = signal(SignalKind::quit()).ok()?;"},{"Add":" let mut user_defined1_stream = signal(SignalKind::user_defined1()).ok()?;"},{"Add":" let mut user_defined2_stream = signal(SignalKind::user_defined2()).ok()?;"},{"Add":""},{"Add":" let interrupt_future = interrupt_stream.recv();"},{"Add":" let terminate_future = terminate_stream.recv();"},{"Add":" let alarm_future = alarm_stream.recv();"},{"Add":" let hangup_future = hangup_stream.recv();"},{"Add":" let quit_future = quit_stream.recv();"},{"Add":" let user_defined1_future = user_defined1_stream.recv();"},{"Add":" let user_defined2_future = user_defined2_stream.recv();"},{"Add":""},{"Add":" let all_futures = vec!["},{"Add":" interrupt_future,"},{"Add":" terminate_future,"},{"Add":" alarm_future,"},{"Add":" hangup_future,"},{"Add":" quit_future,"},{"Add":" user_defined1_future,"},{"Add":" user_defined2_future,"},{"Add":" ];"},{"Add":""},{"Add":" let mut signal_map = HashMap::with_capacity(all_futures.len());"},{"Add":""},{"Add":" signal_map.insert(0, SignalKind::interrupt().as_raw_value());"},{"Add":" signal_map.insert(1, SignalKind::terminate().as_raw_value());"},{"Add":" signal_map.insert(2, SignalKind::alarm().as_raw_value());"},{"Add":" signal_map.insert(3, SignalKind::hangup().as_raw_value());"},{"Add":" signal_map.insert(4, SignalKind::quit().as_raw_value());"},{"Add":" signal_map.insert(5, SignalKind::user_defined1().as_raw_value());"},{"Add":" signal_map.insert(6, SignalKind::user_defined2().as_raw_value());"},{"Add":""},{"Add":" let all_futures = all_futures"},{"Add":" .into_iter()"},{"Add":" .enumerate()"},{"Add":" .map(|(i, fut)| fut.map(move |res| (i, res)))"},{"Add":" .collect::>();"},{"Add":""},{"Add":" // use collection as a stream, await only first 1 future to complete"},{"Add":" let first_one = all_futures.take(1).collect::>().await;"},{"Add":" let signal_index = first_one[0].0;"},{"Add":""},{"Add":" // Currently we mask all signals to SIGTERM."},{"Add":" let received = signal_map[&signal_index];"},{"Add":""},{"Add":" info!(\"SIGNAL_GUARD: RECEIVED CODE {} FROM OS\", received);"},{"Add":""},{"Add":" signal_forwarder.send(received).unwrap();"},{"Add":""},{"Add":" Option::Some(())"},{"Add":" }"},{"Add":"}"}],"del_contents":[{"Del":"use futures::prelude::*;\nuse futures::stream::FuturesUnordered;\nuse log::info;\nuse std::collections::HashMap;\nuse tokio::signal::unix::{signal, SignalKind};\nuse tokio::sync::broadcast::Sender;\n\npub struct SignalGuard {}\n\nimpl SignalGuard {\n pub async fn wait_for_stop(signal_forwarder: &Sender) -> Option<()> {\n // Default behavior in UNIX is to terminate process when any of the\n // following signals are received. In each of these case we initiate\n // the controlled shutdown.\n let mut interrupt_stream = signal(SignalKind::interrupt()).ok()?;\n let mut terminate_stream = signal(SignalKind::terminate()).ok()?;\n let mut alarm_stream = signal(SignalKind::alarm()).ok()?;\n let mut hangup_stream = signal(SignalKind::hangup()).ok()?;\n let mut quit_stream = signal(SignalKind::quit()).ok()?;\n let mut user_defined1_stream = signal(SignalKind::user_defined1()).ok()?;\n let mut user_defined2_stream = signal(SignalKind::user_defined2()).ok()?;\n\n let interrupt_future = interrupt_stream.recv();\n let terminate_future = terminate_stream.recv();\n let alarm_future = alarm_stream.recv();\n let hangup_future = hangup_stream.recv();\n let quit_future = quit_stream.recv();\n let user_defined1_future = user_defined1_stream.recv();\n let user_defined2_future = user_defined2_stream.recv();\n\n let all_futures = vec![\n interrupt_future,\n terminate_future,\n alarm_future,\n hangup_future,\n quit_future,\n user_defined1_future,\n user_defined2_future,\n ];\n\n let mut signal_map = HashMap::with_capacity(all_futures.len());\n\n signal_map.insert(0, SignalKind::interrupt().as_raw_value());\n signal_map.insert(1, SignalKind::terminate().as_raw_value());\n signal_map.insert(2, SignalKind::alarm().as_raw_value());\n signal_map.insert(3, SignalKind::hangup().as_raw_value());\n signal_map.insert(4, SignalKind::quit().as_raw_value());\n signal_map.insert(5, SignalKind::user_defined1().as_raw_value());\n signal_map.insert(6, SignalKind::user_defined2().as_raw_value());\n\n let all_futures = all_futures\n .into_iter()\n .enumerate()\n .map(|(i, fut)| fut.map(move |res| (i, res)))\n .collect::>();\n\n // use collection as a stream, await only first 1 future to complete\n let first_one = all_futures.take(1).collect::>().await;\n let signal_index = first_one[0].0;\n\n // Currently we mask all signals to SIGTERM.\n let received = signal_map[&signal_index];\n\n info!(\"SIGNAL_GUARD: RECEIVED CODE {} FROM OS\", received);\n\n signal_forwarder.send(received).unwrap();\n\n Option::Some(())\n }\n}\n"}]}},{"Replacement":{"inode":{"change":3,"pos":36},"path":"src/shutdown.rs","line":1,"ins":{"up_context":[{"change":3,"pos":36}],"down_context":[],"flag":"BLOCK","start":2857,"end":3847,"inode":{"change":3,"pos":36}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":36},"to":{"change":2,"start":2857,"end":3675},"introduced_by":2}],"inode":{"change":3,"pos":36}},"ins_contents":[{"Add":"// Adapted from: https://github.com/tokio-rs/mini-redis/blob/069a8e5ee0de445ad3e642548d196ef6b4fa8bc1/src/shutdown.rs"},{"Add":""},{"Add":"use tokio::sync::broadcast;"},{"Add":""},{"Add":"pub struct Shutdown {"},{"Add":" /// The receive half of the channel used to listen for shutdown."},{"Add":" notify: broadcast::Receiver,"},{"Add":" received: bool,"},{"Add":"}"},{"Add":""},{"Add":"impl Shutdown {"},{"Add":" /// Create a new `Shutdown` backed by the given `broadcast::Receiver`."},{"Add":" pub fn new(notify: broadcast::Receiver) -> Self {"},{"Add":" Self {"},{"Add":" notify,"},{"Add":" received: false,"},{"Add":" }"},{"Add":" }"},{"Add":""},{"Add":" pub fn replicate(&self) -> Self {"},{"Add":" Self {"},{"Add":" notify: self.notify.resubscribe(),"},{"Add":" received: self.received,"},{"Add":" }"},{"Add":" }"},{"Add":""},{"Add":" /// Receive the shutdown notice, waiting if necessary."},{"Add":" pub async fn recv(&mut self) {"},{"Add":" if self.received {"},{"Add":" return;"},{"Add":" }"},{"Add":""},{"Add":" // Cannot receive a \"lag error\" as only one value is ever sent."},{"Add":" let _ = self.notify.recv().await;"},{"Add":""},{"Add":" self.received = true;"},{"Add":" }"},{"Add":"}"}],"del_contents":[{"Del":"// Adapted from: https://github.com/tokio-rs/mini-redis/blob/069a8e5ee0de445ad3e642548d196ef6b4fa8bc1/src/shutdown.rs\n\nuse tokio::sync::broadcast;\n\npub struct Shutdown {\n /// The receive half of the channel used to listen for shutdown.\n notify: broadcast::Receiver,\n}\n\nimpl Shutdown {\n /// Create a new `Shutdown` backed by the given `broadcast::Receiver`.\n pub fn new(notify: broadcast::Receiver) -> Self {\n Self { notify }\n }\n\n #[allow(dead_code)]\n pub fn replicate(&self) -> Self {\n Self {\n notify: self.notify.resubscribe(),\n }\n }\n\n /// Receive the shutdown notice, waiting if necessary.\n pub async fn recv(&mut self) {\n // Cannot receive a \"lag error\" as only one value is ever sent.\n let _ = self.notify.recv().await;\n }\n}\n"}]}},{"Replacement":{"inode":{"change":3,"pos":891},"path":"src/service.rs","line":1,"ins":{"up_context":[{"change":3,"pos":891}],"down_context":[],"flag":"BLOCK","start":3848,"end":6007,"inode":{"change":3,"pos":891}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":891},"to":{"change":2,"start":3676,"end":4115},"introduced_by":2}],"inode":{"change":3,"pos":891}},"ins_contents":[{"Add":"use crate::shutdown::Shutdown;"},{"Add":"use log::info;"},{"Add":"use tokio::io::{AsyncReadExt, AsyncWriteExt};"},{"Add":"use tokio::net::TcpListener;"},{"Add":""},{"Add":"pub struct Service {"},{"Add":" control: Shutdown,"},{"Add":"}"},{"Add":""},{"Add":"impl Service {"},{"Add":" pub fn new(control: Shutdown) -> Self {"},{"Add":" Self { control }"},{"Add":" }"},{"Add":""},{"Add":" pub async fn serve(&mut self) -> Option<()> {"},{"Add":" info!(\"SERVICE: RUN\");"},{"Add":""},{"Add":" let communication_loop = tokio::spawn(async move {"},{"Add":" let listener = TcpListener::bind(\"127.0.0.1:8080\").await.ok()?;"},{"Add":""},{"Add":" loop {"},{"Add":" // Wait for incoming network request."},{"Add":" // Dispatch it to the communicator and repeat."},{"Add":""},{"Add":" // This is ECHO server example from the Tokio dokumentation."},{"Add":" let (mut socket, _) = listener.accept().await.ok()?;"},{"Add":""},{"Add":" tokio::spawn(async move {"},{"Add":" let mut buf = [0; 1024];"},{"Add":""},{"Add":" // In a loop, read data from the socket and write the data back."},{"Add":" loop {"},{"Add":" let n = match socket.read(&mut buf).await {"},{"Add":" // socket closed"},{"Add":" Ok(n) if n == 0 => return Option::Some(()),"},{"Add":" Ok(n) => n,"},{"Add":" Err(e) => {"},{"Add":" eprintln!(\"failed to read from socket; err = {:?}\", e);"},{"Add":" return Option::Some(());"},{"Add":" }"},{"Add":" };"},{"Add":""},{"Add":" // Write the data back"},{"Add":" if let Err(e) = socket.write_all(&buf[0..n]).await {"},{"Add":" eprintln!(\"failed to write to socket; err = {:?}\", e);"},{"Add":" return Option::Some(());"},{"Add":" }"},{"Add":" }"},{"Add":" });"},{"Add":" }"},{"Add":""},{"Add":" // TODO: Needs some cleanup as this required by"},{"Add":" // compiler but does generate warning."},{"Add":" Option::Some(())"},{"Add":" });"},{"Add":""},{"Add":" self.control.recv().await;"},{"Add":" info!(\"SERVICE: RECEIVED CONTROL SIGNAL\");"},{"Add":""},{"Add":" communication_loop.abort();"},{"Add":""},{"Add":" info!(\"COMMUNICATION: CANCELLED\");"},{"Add":" info!(\"SERVICE: STOP\");"},{"Add":""},{"Add":" Option::Some(())"},{"Add":" }"},{"Add":"}"}],"del_contents":[{"Del":"use tokio::time::{sleep, Duration};\npub struct Service {}\n\npub struct ServiceError {}\n\nimpl Service {\n pub fn new() -> Self {\n Self {}\n }\n\n pub async fn wait(&self) -> Result {\n sleep(Duration::from_secs(7)).await;\n Result::Ok(117)\n }\n\n pub async fn serve(&self, _handle: u64) -> Result<(), ServiceError> {\n sleep(Duration::from_secs(15)).await;\n Result::Ok(())\n }\n}\n"}]}},{"Edit":{"inode":{"change":3,"pos":34},"path":"src/server.rs","line":3,"atom":{"EdgeMap":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":1392},"to":{"change":3,"start":1392,"end":1408},"introduced_by":3}],"inode":{"change":3,"pos":34}}},"contents":[{"Del":"use log::error;\n"}]}},{"Edit":{"inode":{"change":3,"pos":34},"path":"src/server.rs","line":21,"atom":{"EdgeMap":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":1709},"to":{"change":3,"start":1709,"end":1799},"introduced_by":3},{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":1799},"to":{"change":2,"start":4116,"end":4135},"introduced_by":2},{"previous":"","flag":"DELETED","from":{"change":2,"pos":4135},"to":{"change":3,"start":1833,"end":1935},"introduced_by":2},{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":1833},"to":{"change":3,"start":1833,"end":1935},"introduced_by":3}],"inode":{"change":3,"pos":34}}},"contents":[{"Del":"\n let service_loop = tokio::spawn(async move {\n info!(\"SERVICE: RUN\");\n\n"},{"Del":" loop {\n"},{"Del":" let round = Service::new();\n\n let service_handle = round.wait().await;\n"}]}},{"Replacement":{"inode":{"change":3,"pos":34},"path":"src/server.rs","line":22,"ins":{"up_context":[{"change":3,"pos":1936}],"down_context":[{"change":3,"pos":2156}],"flag":"BLOCK","start":6008,"end":6062,"inode":{"change":3,"pos":34}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":1936},"to":{"change":3,"start":1936,"end":2156},"introduced_by":3}],"inode":{"change":3,"pos":34}},"ins_contents":[{"Add":" let child_control = self.control.replicate();"}],"del_contents":[{"Del":" match service_handle {\n Ok(handle) => {\n tokio::spawn(async move {\n info!(\"SERVICE: PROCESSING (REASON: Acquired handle {}).\",handle);\n"}]}},{"Replacement":{"inode":{"change":3,"pos":34},"path":"src/server.rs","line":24,"ins":{"up_context":[{"change":3,"pos":2157}],"down_context":[{"change":3,"pos":2235}],"flag":"BLOCK","start":6063,"end":6178,"inode":{"change":3,"pos":34}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":2157},"to":{"change":3,"start":2157,"end":2235},"introduced_by":3}],"inode":{"change":3,"pos":34}},"ins_contents":[{"Add":" let service_loop = tokio::spawn(async {"},{"Add":" let mut network_service = Service::new(child_control);"}],"del_contents":[{"Del":" let service_response = round.serve(handle).await;\n"}]}},{"Replacement":{"inode":{"change":3,"pos":34},"path":"src/server.rs","line":27,"ins":{"up_context":[{"change":3,"pos":2236}],"down_context":[{"change":3,"pos":2787}],"flag":"BLOCK","start":6179,"end":6222,"inode":{"change":3,"pos":34}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":2236},"to":{"change":3,"start":2236,"end":2787},"introduced_by":3}],"inode":{"change":3,"pos":34}},"ins_contents":[{"Add":" network_service.serve().await;"}],"del_contents":[{"Del":" match service_response {\n Ok(_) => info!(\"SERVICE: PROCESSED (REASON: Handle {} has been processed.)\",handle),\n Err(_service_error) => error!(\"SERVICE: FAILURE (REASON: Request handling error for handle {}.)\",handle)\n }\n });\n }\n Err(_service_error) => error!(\"SERVICE: FAILURE (REASON: Unable to acquire new handle for request servicing.)\")\n }\n }\n"}]}},{"Edit":{"inode":{"change":3,"pos":34},"path":"src/server.rs","line":31,"atom":{"EdgeMap":{"edges":[{"previous":"","flag":"DELETED","from":{"change":3,"pos":2835},"to":{"change":3,"start":276,"end":277},"introduced_by":3},{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":276},"to":{"change":3,"start":276,"end":277},"introduced_by":3}],"inode":{"change":3,"pos":34}}},"contents":[{"Del":"\n"}]}},{"Replacement":{"inode":{"change":3,"pos":2991},"path":"log4rs.config.yml","line":1,"ins":{"up_context":[{"change":3,"pos":2991}],"down_context":[],"flag":"BLOCK","start":6223,"end":6336,"inode":{"change":3,"pos":2991}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":2991},"to":{"change":2,"start":4162,"end":4275},"introduced_by":2}],"inode":{"change":3,"pos":2991}},"ins_contents":[{"Add":"refresh_rate: 30 seconds"},{"Add":""},{"Add":"appenders:"},{"Add":" stdout:"},{"Add":" kind: console"},{"Add":""},{"Add":"root:"},{"Add":" level: trace"},{"Add":" appenders:"},{"Add":" - stdout"}],"del_contents":[{"Del":"refresh_rate: 30 seconds\n\nappenders:\n stdout:\n kind: console\n\nroot:\n level: trace\n appenders:\n - stdout\n"}]}},{"Replacement":{"inode":{"change":3,"pos":1080},"path":"adr/Design.md","line":1,"ins":{"up_context":[{"change":3,"pos":1080}],"down_context":[],"flag":"BLOCK","start":6337,"end":9850,"inode":{"change":3,"pos":1080}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":1080},"to":{"change":2,"start":4276,"end":7789},"introduced_by":2}],"inode":{"change":3,"pos":1080}},"ins_contents":[{"Add":"# Concepts"},{"Add":""},{"Add":"This chapter describes the core concepts around the implementation and the IRC specification. Some material may be restated from the source but it is gathered here for reference purposes."},{"Add":""},{"Add":"## IRC"},{"Add":""},{"Add":"For the core IRC concepts see: [IRC concepts](https://modern.ircdocs.horse/#irc-concepts)"},{"Add":""},{"Add":"## Implementation"},{"Add":""},{"Add":"### Client"},{"Add":""},{"Add":"This is something that sends bytes to our server according to the IRC protocol (something that communicates with the server but is not a server). This is also something outside of this implementation and this is modelled as something from which we receive and send bytes to."},{"Add":""},{"Add":"### Server"},{"Add":""},{"Add":"This is our implementation which communicates with the client and other servers in the same network. According to IRC specification network consists of servers and even though there is server to server protocols available in practise one network consists of same server implementations and they can use any protocol they wish to communicate state changes between them. We will utilize this in our implementation."},{"Add":""},{"Add":"### User"},{"Add":""},{"Add":"This entity models a real user (either human or bot) which uses the client to communicate with our server."},{"Add":""},{"Add":"### Channel"},{"Add":""},{"Add":"Channels represent the logical conversation groups in an IRC network. These are synced between servers in the network. This entity ties users to channels in which they can exchange messages."},{"Add":""},{"Add":"### Capability"},{"Add":""},{"Add":"When the client connects to the server they first have an exchange of information which tells the client what capabilities the server provides. This allows the client to establish reasonable communication with the server. In the implementation different capabilities are implemented in a modular manner which are queried during runtime to provide the capability information to the client."},{"Add":""},{"Add":"# Architecture"},{"Add":""},{"Add":"In general principle we follow modular monolith approach where we have a single executable for the application but that application is composed of modules which are independent and focus on specific features (capabilities) and the runtime then ties these together. In addition there are modules which handles the low-level work of communication."},{"Add":""},{"Add":"## Components"},{"Add":""},{"Add":"### Server"},{"Add":""},{"Add":"This is the main high-level component that drives our server instance."},{"Add":""},{"Add":"#### Capability"},{"Add":""},{"Add":"There are multiple capability components that each implement a specific functionality to the server."},{"Add":""},{"Add":"### Pool"},{"Add":""},{"Add":"This is the component which tracks the running service instance in the network it is attached to. Network can consist of single server instance. State changes in this instance are then propagated to other servers in pool."},{"Add":""},{"Add":"#### Server Communicator"},{"Add":""},{"Add":"This sub-component of the pool manages the communication between server instances."},{"Add":""},{"Add":"### State Manager"},{"Add":""},{"Add":"This component maintains the state information (users, channels, etc.) for the current instance. It is linked to the pool component and the pool observes the changes in the state manager and propagates them forward and vice versa. That is pool may receive state update from a different server instance and pool then signals these changes to this instance's state manager."},{"Add":""},{"Add":"### Protocol Stack"},{"Add":""},{"Add":"This component maintains the reference information for different communication and message components about specific IRC code constants and other similar information in the IRC protocol."},{"Add":""},{"Add":"### Communicator"},{"Add":""},{"Add":"This component is responsible for sending and receiving bytes between client and server. It ensures the correct formatting of messages and their validation. This component is also linked to the state manager."}],"del_contents":[{"Del":"# Concepts\n\nThis chapter describes the core concepts around the implementation and the IRC specification. Some material may be restated from the source but it is gathered here for reference purposes.\n\n## IRC\n\nFor the core IRC concepts see: [IRC concepts](https://modern.ircdocs.horse/#irc-concepts)\n\n## Implementation\n\n### Client\n\nThis is something that sends bytes to our server according to the IRC protocol (something that communicates with the server but is not a server). This is also something outside of this implementation and this is modelled as something from which we receive and send bytes to.\n\n### Server\n\nThis is our implementation which communicates with the client and other servers in the same network. According to IRC specification network consists of servers and even though there is server to server protocols available in practise one network consists of same server implementations and they can use any protocol they wish to communicate state changes between them. We will utilize this in our implementation.\n\n### User\n\nThis entity models a real user (either human or bot) which uses the client to communicate with our server.\n\n### Channel\n\nChannels represent the logical conversation groups in an IRC network. These are synced between servers in the network. This entity ties users to channels in which they can exchange messages.\n\n### Capability\n\nWhen the client connects to the server they first have an exchange of information which tells the client what capabilities the server provides. This allows the client to establish reasonable communication with the server. In the implementation different capabilities are implemented in a modular manner which are queried during runtime to provide the capability information to the client.\n\n# Architecture\n\nIn general principle we follow modular monolith approach where we have a single executable for the application but that application is composed of modules which are independent and focus on specific features (capabilities) and the runtime then ties these together. In addition there are modules which handles the low-level work of communication.\n\n## Components\n\n### Server\n\nThis is the main high-level component that drives our server instance.\n\n#### Capability\n\nThere are multiple capability components that each implement a specific functionality to the server.\n\n### Pool\n\nThis is the component which tracks the running service instance in the network it is attached to. Network can consist of single server instance. State changes in this instance are then propagated to other servers in pool.\n\n#### Server Communicator\n\nThis sub-component of the pool manages the communication between server instances.\n\n### State Manager\n\nThis component maintains the state information (users, channels, etc.) for the current instance. It is linked to the pool component and the pool observes the changes in the state manager and propagates them forward and vice versa. That is pool may receive state update from a different server instance and pool then signals these changes to this instance's state manager.\n\n### Protocol Stack\n\nThis component maintains the reference information for different communication and message components about specific IRC code constants and other similar information in the IRC protocol.\n\n### Communicator\n\nThis component is responsible for sending and receiving bytes between client and server. It ensures the correct formatting of messages and their validation. This component is also linked to the state manager.\n"}]}}],"owner":"mvarjon","repo":"plan9","token":"it4Efjq0CqmK7J8SL2WRxtcvEWEUBRQ3kIbyqGEcEa4=","login":null}

…

Dependencies

Change contents