Skip to content
This repository has been archived by the owner on Jan 4, 2023. It is now read-only.

[2.0] Update protocol spec documentation #478

Closed
13 tasks done
jlu5 opened this issue Jul 1, 2017 · 0 comments
Closed
13 tasks done

[2.0] Update protocol spec documentation #478

jlu5 opened this issue Jul 1, 2017 · 0 comments
Labels
involves: docs/packaging docs changes or misc project-related tasks involves: protocol spec involves changing the protocol spec release blocker issues/PRs blocking the next release
Milestone

Comments

@jlu5
Copy link
Collaborator

jlu5 commented Jul 1, 2017

Some of the things that need to be mentioned:

  • The old Irc and Protocol classes were merged together in 2.0, meaning that there is now only one connect() function in each class
    • IRCd protocol modules that used to define connect() now define post_connect() to prevent a name collision (this is an API breaking change!)
  • 2.0 protocol modules should now inherit from either classes.IRCNetwork, classes.PyLinkNetworkCoreWithUtils, or protocols.ircs2s_common.IRCCommonProtocol based on how much separation is needed
    • XXX: elaborate more on this
  • Renamed members:
    • spawnClient → spawn_client
    • spawnServer → spawn_server
    • updateClient → update_client
    • topicBurst → topic_burst
    • connect → post_connect
    • ping → _ping_uplink (also updated args)
  • Mention specific lists that need to be enumerated
    • On connect, add the user to its servers' user list; this is needed for SQUIT handling
    • On JOIN, add the user to the channels' user list AND the channel to the users' channel list - plugins implicitly depend on this consistency in various places
@jlu5 jlu5 added involves: docs/packaging docs changes or misc project-related tasks involves: protocol spec involves changing the protocol spec labels Jul 1, 2017
@jlu5 jlu5 added this to the v2.0 milestone Jul 1, 2017
@jlu5 jlu5 added the release blocker issues/PRs blocking the next release label Oct 1, 2017
jlu5 added a commit that referenced this issue Oct 6, 2017
@jlu5 jlu5 closed this as completed Oct 6, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
involves: docs/packaging docs changes or misc project-related tasks involves: protocol spec involves changing the protocol spec release blocker issues/PRs blocking the next release
Projects
None yet
Development

No branches or pull requests

1 participant