Git Product home page Git Product logo

weechat_notifier's Introduction

weechat-notifier

Get a local notification from your remote weechat session!

Goals

My goal with this project is to build a rust version of mythmon/page. Mostly because I wanted to write a parser for weechat's relay protocol but a little because if you use a command like LIST on irc.freenode.org it would heat up one of your cores for a while and you would stop receiving notifications for a couple minutes.

Modules

Currently there are 3 modules in this repo. weechat-notifier, weechat-client, and weechat-parser. If any of these gain more adoption outside of my use cases I'll break them out into their own repo to enable more clear communication and development history.

weechat-notifier

This is the root module. It will provide the command line interface to starting the daemon as well as the daemon itself. This is where any further modules will likely grow out of.

weechat-client

This module handles getting a connection to the weechat relay server, hooking it up to the parser and maintaining any state needed to keep the connection alive as well as reconnect if desired. This is what most people will use instead of directly using the weechat-parser module.

Currently it just connects emits events on a MPSC channel.

It will grow to have more capabilities to send commands to the server and filtering around emitted events.

weechat-parser

Split into its own module for conceptual/develmental reasons this module is also more useful to folks who don't like the connection or threading modules used by weechat-client and want to build their own.

This module currently works via MPSC channels as well. It takes 2, a receiving end and a transmitting end. This way it can interact with pretty much any network library and many types of abstractions are possible on top of the emitted event stream.

weechat_notifier's People

Contributors

wraithan avatar

Stargazers

tg-z avatar  avatar Bret Comnes avatar Xe Iaso avatar Kyle Terry avatar

Watchers

 avatar James Cloos avatar

Forkers

andir

weechat_notifier's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.