docs: Add documentation for BUrlProtocolListener

Change-Id: I6fb6092d31e9ff94a1c9466240b375b9b88f2d8f Reviewed-on: https://review.haiku-os.org/c/haiku/+/2929 Reviewed-by: waddlesplash <[email protected]>
2020-06-20 18:13:33 +00:00
parent fcf08bbd68
commit b927cf6822
2 changed files with 151 additions and 85 deletions
@@ -28,109 +28,24 @@ enum BUrlProtocolDebugMessage {

 class BUrlProtocolListener {
 public:
-	/**
-		ConnectionOpened()
-		Frequency:	Once
-
-		Called when the socket is opened.
-	*/
 	virtual	void				ConnectionOpened(BUrlRequest* caller);
-
-	/**
-		HostnameResolved(ip)
-		Frequency:	Once
-		Parameters:	ip		 String representing the IP address of the resource
-							host.
-
-		Called when the final IP is discovered
-	*/
 	virtual void				HostnameResolved(BUrlRequest* caller,
 									const char* ip);
-
-	/**
-		ReponseStarted()
-		Frequency:	Once
-
-		Called when the request has been emitted and the server begins to
-		reply. Typically when the HTTP status code is received.
-	*/
 	virtual void				ResponseStarted(BUrlRequest* caller);
-
-	/**
-		HeadersReceived()
-		Frequency:	Once
-
-		Called when all the server response metadata (such as headers) have
-		been read and parsed.
-	*/
 	virtual void				HeadersReceived(BUrlRequest* caller,
 									const BUrlResult& result);
-
-	/**
-		DataReceived(data, position, size)
-		Frequency:	Zero or more
-		Parameters:	data	 Pointer to the data block in memory
-					position Offset of the data in the stream
-					size	 Size of the data block
-
-		Called each time a full block of data is received.
-	*/
 	virtual void				DataReceived(BUrlRequest* caller,
 									const char* data, off_t position,
 									ssize_t size);
-
-	/**
-		DownloadProgress(bytesReceived, bytesTotal)
-		Frequency:	Once or more
-		Parameters:	bytesReceived	Number of data bytes received
-					bytesTotal		Total number of data bytes expected
-
-		Called each time a data block is received.
-	*/
 	virtual	void				DownloadProgress(BUrlRequest* caller,
 									ssize_t bytesReceived, ssize_t bytesTotal);
-
-	/**
-		UploadProgress(bytesSent, bytesTotal)
-		Frequency:	Once or more
-		Parameters:	bytesSent		Number of data bytes sent
-					bytesTotal		Total number of data bytes expected
-
-		Called each time a data block is emitted.
-	*/
 	virtual void				UploadProgress(BUrlRequest* caller,
 									ssize_t bytesSent, ssize_t bytesTotal);
-
-	/**
-		RequestCompleted(success)
-		Frequency:	Once
-		Parameters:	success			true if the resource have been successfully
-									false if not
-
-		Called once the request is complete.
-	*/
 	virtual void				RequestCompleted(BUrlRequest* caller,
 									bool success);
-
-	/**
-		DebugMessage(type, text)
-		Frequency:	zero or more
-		Parameters:	type	Type of the verbose message (see BUrlProtocolDebug)
-
-		Called each time a debug message is emitted
-	*/
 	virtual void				DebugMessage(BUrlRequest* caller,
 									BUrlProtocolDebugMessage type,
 									const char* text);
-
-	/**
-		CertificateVerificationFailed(certificate, message)
-		Frequency: Once
-		Parameters: certificate	SSL certificate which coulnd't be validated
-					message error message describing the problem
-
-		Return true to proceed anyway, false to abort the connection
-	*/
 	virtual bool				CertificateVerificationFailed(
 									BUrlRequest* caller,
 									BCertificate& certificate,