update docs

serverhandler.go

@@ -12,17 +12,18 @@ import (
 // ServerHandler is the interface implemented by all the server handlers.
 type ServerHandler interface{}
 
-// ServerHandlerOnConnOpenCtx is the context of a connection opening.
+// ServerHandlerOnConnOpenCtx is the context of OnConnOpen.
 type ServerHandlerOnConnOpenCtx struct {
 	Conn *ServerConn
 }
 
 // ServerHandlerOnConnOpen can be implemented by a ServerHandler.
 type ServerHandlerOnConnOpen interface {
+	// called when a connection is opened.
 	OnConnOpen(*ServerHandlerOnConnOpenCtx)
 }
 
-// ServerHandlerOnConnCloseCtx is the context of a connection closure.
+// ServerHandlerOnConnCloseCtx is the context of OnConnClose.
 type ServerHandlerOnConnCloseCtx struct {
 	Conn  *ServerConn
 	Error error
@@ -30,10 +31,11 @@ type ServerHandlerOnConnCloseCtx struct {
 
 // ServerHandlerOnConnClose can be implemented by a ServerHandler.
 type ServerHandlerOnConnClose interface {
+	// called when a connection is closed.
 	OnConnClose(*ServerHandlerOnConnCloseCtx)
 }
 
-// ServerHandlerOnSessionOpenCtx is the context of a session opening.
+// ServerHandlerOnSessionOpenCtx is the context OnSessionOpen.
 type ServerHandlerOnSessionOpenCtx struct {
 	Session *ServerSession
 	Conn    *ServerConn
@@ -41,10 +43,11 @@ type ServerHandlerOnSessionOpenCtx struct {
 
 // ServerHandlerOnSessionOpen can be implemented by a ServerHandler.
 type ServerHandlerOnSessionOpen interface {
+	// called when a session is opened.
 	OnSessionOpen(*ServerHandlerOnSessionOpenCtx)
 }
 
-// ServerHandlerOnSessionCloseCtx is the context of a session closure.
+// ServerHandlerOnSessionCloseCtx is the context of ServerHandlerOnSessionClose.
 type ServerHandlerOnSessionCloseCtx struct {
 	Session *ServerSession
 	Error   error
@@ -52,20 +55,23 @@ type ServerHandlerOnSessionCloseCtx struct {
 
 // ServerHandlerOnSessionClose can be implemented by a ServerHandler.
 type ServerHandlerOnSessionClose interface {
+	// called when a session is closed.
 	OnSessionClose(*ServerHandlerOnSessionCloseCtx)
 }
 
 // ServerHandlerOnRequest can be implemented by a ServerHandler.
 type ServerHandlerOnRequest interface {
+	// called before every request.
 	OnRequest(*ServerConn, *base.Request)
 }
 
 // ServerHandlerOnResponse can be implemented by a ServerHandler.
 type ServerHandlerOnResponse interface {
+	// called after every response.
 	OnResponse(*ServerConn, *base.Response)
 }
 
-// ServerHandlerOnDescribeCtx is the context of a DESCRIBE request.
+// ServerHandlerOnDescribeCtx is the context of OnDescribe.
 type ServerHandlerOnDescribeCtx struct {
 	Conn    *ServerConn
 	Request *base.Request
@@ -75,10 +81,11 @@ type ServerHandlerOnDescribeCtx struct {
 
 // ServerHandlerOnDescribe can be implemented by a ServerHandler.
 type ServerHandlerOnDescribe interface {
+	// called after receiving a DESCRIBE request.
 	OnDescribe(*ServerHandlerOnDescribeCtx) (*base.Response, *ServerStream, error)
 }
 
-// ServerHandlerOnAnnounceCtx is the context of an ANNOUNCE request.
+// ServerHandlerOnAnnounceCtx is the context of OnAnnounce.
 type ServerHandlerOnAnnounceCtx struct {
 	Server  *Server
 	Session *ServerSession
@@ -91,10 +98,11 @@ type ServerHandlerOnAnnounceCtx struct {
 
 // ServerHandlerOnAnnounce can be implemented by a ServerHandler.
 type ServerHandlerOnAnnounce interface {
+	// called after receiving an ANNOUNCE request.
 	OnAnnounce(*ServerHandlerOnAnnounceCtx) (*base.Response, error)
 }
 
-// ServerHandlerOnSetupCtx is the context of a OPTIONS request.
+// ServerHandlerOnSetupCtx is the context of OnSetup.
 type ServerHandlerOnSetupCtx struct {
 	Server    *Server
 	Session   *ServerSession
@@ -108,6 +116,7 @@ type ServerHandlerOnSetupCtx struct {
 
 // ServerHandlerOnSetup can be implemented by a ServerHandler.
 type ServerHandlerOnSetup interface {
+	// called after receiving a SETUP request.
 	// must return a Response and a stream.
 	// the stream is needed to
 	// - add the session the the stream's readers
@@ -115,7 +124,7 @@ type ServerHandlerOnSetup interface {
 	OnSetup(*ServerHandlerOnSetupCtx) (*base.Response, *ServerStream, error)
 }
 
-// ServerHandlerOnPlayCtx is the context of a PLAY request.
+// ServerHandlerOnPlayCtx is the context of OnPlay.
 type ServerHandlerOnPlayCtx struct {
 	Session *ServerSession
 	Conn    *ServerConn
@@ -126,10 +135,11 @@ type ServerHandlerOnPlayCtx struct {
 
 // ServerHandlerOnPlay can be implemented by a ServerHandler.
 type ServerHandlerOnPlay interface {
+	// called after receiving a PLAY request.
 	OnPlay(*ServerHandlerOnPlayCtx) (*base.Response, error)
 }
 
-// ServerHandlerOnRecordCtx is the context of a RECORD request.
+// ServerHandlerOnRecordCtx is the context of OnRecord.
 type ServerHandlerOnRecordCtx struct {
 	Session *ServerSession
 	Conn    *ServerConn
@@ -140,10 +150,11 @@ type ServerHandlerOnRecordCtx struct {
 
 // ServerHandlerOnRecord can be implemented by a ServerHandler.
 type ServerHandlerOnRecord interface {
+	// called after receiving a RECORD request.
 	OnRecord(*ServerHandlerOnRecordCtx) (*base.Response, error)
 }
 
-// ServerHandlerOnPauseCtx is the context of a PAUSE request.
+// ServerHandlerOnPauseCtx is the context of OnPause.
 type ServerHandlerOnPauseCtx struct {
 	Session *ServerSession
 	Conn    *ServerConn
@@ -154,10 +165,11 @@ type ServerHandlerOnPauseCtx struct {
 
 // ServerHandlerOnPause can be implemented by a ServerHandler.
 type ServerHandlerOnPause interface {
+	// called after receiving a PAUSE request.
 	OnPause(*ServerHandlerOnPauseCtx) (*base.Response, error)
 }
 
-// ServerHandlerOnGetParameterCtx is the context of a GET_PARAMETER request.
+// ServerHandlerOnGetParameterCtx is the context of OnGetParameter.
 type ServerHandlerOnGetParameterCtx struct {
 	Session *ServerSession
 	Conn    *ServerConn
@@ -168,10 +180,11 @@ type ServerHandlerOnGetParameterCtx struct {
 
 // ServerHandlerOnGetParameter can be implemented by a ServerHandler.
 type ServerHandlerOnGetParameter interface {
+	// called after receiving a GET_PARAMETER request.
 	OnGetParameter(*ServerHandlerOnGetParameterCtx) (*base.Response, error)
 }
 
-// ServerHandlerOnSetParameterCtx is the context of a SET_PARAMETER request.
+// ServerHandlerOnSetParameterCtx is the context of OnSetParameter.
 type ServerHandlerOnSetParameterCtx struct {
 	Session *ServerSession
 	Conn    *ServerConn
@@ -182,10 +195,11 @@ type ServerHandlerOnSetParameterCtx struct {
 
 // ServerHandlerOnSetParameter can be implemented by a ServerHandler.
 type ServerHandlerOnSetParameter interface {
+	// called after receiving a SET_PARAMETER request.
 	OnSetParameter(*ServerHandlerOnSetParameterCtx) (*base.Response, error)
 }
 
-// ServerHandlerOnPacketRTPCtx is the context of a RTP packet.
+// ServerHandlerOnPacketRTPCtx is the context of OnPacketRTP.
 type ServerHandlerOnPacketRTPCtx struct {
 	Session      *ServerSession
 	TrackID      int
@@ -197,10 +211,11 @@ type ServerHandlerOnPacketRTPCtx struct {
 
 // ServerHandlerOnPacketRTP can be implemented by a ServerHandler.
 type ServerHandlerOnPacketRTP interface {
+	// called when receiving a RTP packet.
 	OnPacketRTP(*ServerHandlerOnPacketRTPCtx)
 }
 
-// ServerHandlerOnPacketRTCPCtx is the context of a RTCP packet.
+// ServerHandlerOnPacketRTCPCtx is the context of OnPacketRTCP.
 type ServerHandlerOnPacketRTCPCtx struct {
 	Session *ServerSession
 	TrackID int
@@ -209,5 +224,6 @@ type ServerHandlerOnPacketRTCPCtx struct {
 
 // ServerHandlerOnPacketRTCP can be implemented by a ServerHandler.
 type ServerHandlerOnPacketRTCP interface {
+	// called when receiving a RTCP packet.
 	OnPacketRTCP(*ServerHandlerOnPacketRTCPCtx)
 }