Browse Source

Doc tweaks

tags/v1.0.0
Chris Smith 5 years ago
parent
commit
c11fc58b3e
1 changed files with 18 additions and 5 deletions
  1. 18
    5
      docs/index.adoc

+ 18
- 5
docs/index.adoc View File

@@ -731,13 +731,18 @@ initial data describing its configurations and its features.
731 731
 At this point it is safe to start issuing commands, checking
732 732
 state, joining channels, etc.
733 733
 
734
-==== PingReceived
734
+==== ServerDisconnected
735 735
 * Type: IrcEvent
736
-* Properties:
737
-** `nonce`: `ByteArray` - the unique data that must be included in the reply
736
+* Properties: _(none)_
738 737
 
739
-Raised when the IRC server sends a PING message to the client. KtIrc will
740
-automatically reply with an appropriate PONG.
738
+Raised in all cases where KtIrc has attempted to connect to an IRC server and
739
+has now been disconnected. KtIrc will not automatically attempt to reconnect;
740
+the `connect()` method should be called again after an appropriate delay.
741
+
742
+NOTE: All of KtIrc's internal state, such as details about users and
743
+channels, will be reset when disconnected from the server. State should not
744
+be queried until a new <<ServerReady>> event has been received, at which
745
+point it will have been recreated.
741 746
 
742 747
 ==== ServerCapabilitiesReceived
743 748
 
@@ -853,6 +858,14 @@ TODO
853 858
 
854 859
 === Other events
855 860
 
861
+==== PingReceived
862
+* Type: IrcEvent
863
+* Properties:
864
+** `nonce`: `ByteArray` - the unique data that must be included in the reply
865
+
866
+Raised when the IRC server sends a PING message to the client. KtIrc will
867
+automatically reply with an appropriate PONG.
868
+
856 869
 ==== AuthenticationMessage
857 870
 
858 871
 TODO

Loading…
Cancel
Save