C# Class MailKit.ProtocolLogger

A protocol logger.

Inheritance: IProtocolLogger

Show file Open project: jstedfast/MailKit Class Usage Examples

Public Methods

Method	Description
Dispose ( ) : void	Releases all resource used by the MailKit.ProtocolLogger object. Call Dispose() when you are finished using the MailKit.ProtocolLogger. The Dispose() method leaves the MailKit.ProtocolLogger in an unusable state. After calling Dispose(), you must release all references to the MailKit.ProtocolLogger so the garbage collector can reclaim the memory that the MailKit.ProtocolLogger was occupying.
LogClient ( byte buffer, int offset, int count ) : void	Logs a sequence of bytes sent by the client. Logs a sequence of bytes sent by the client.
LogConnect ( Uri uri ) : void	Logs a connection to the specified URI. Logs a connection to the specified URI.
LogServer ( byte buffer, int offset, int count ) : void	Logs a sequence of bytes sent by the server. Logs a sequence of bytes sent by the server.
ProtocolLogger ( Stream stream ) : System	Initializes a new instance of the MailKit.ProtocolLogger class. Creates a new ProtocolLogger to log to a specified stream.
ProtocolLogger ( string fileName ) : System	Initializes a new instance of the MailKit.ProtocolLogger class. Creates a new ProtocolLogger to log to a specified file.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Releases the unmanaged resources used by the ProtocolLogger and optionally releases the managed resources. Releases the unmanaged resources used by the ProtocolLogger and optionally releases the managed resources.

Private Methods

Method	Description
Log ( byte prefix, bool &midline, byte buffer, int offset, int count ) : void
ValidateArguments ( byte buffer, int offset, int count ) : void

Method Details

Dispose() public method

Releases all resource used by the MailKit.ProtocolLogger object.

Call Dispose() when you are finished using the MailKit.ProtocolLogger. The Dispose() method leaves the MailKit.ProtocolLogger in an unusable state. After calling Dispose(), you must release all references to the MailKit.ProtocolLogger so the garbage collector can reclaim the memory that the MailKit.ProtocolLogger was occupying.

public Dispose ( ) : void
return	void

Dispose() protected method

Releases the unmanaged resources used by the ProtocolLogger and optionally releases the managed resources.

protected Dispose ( bool disposing ) : void
disposing	bool	true to release both managed and unmanaged resources; /// false to release only the unmanaged resources.
return	void

LogClient() public method

Logs a sequence of bytes sent by the client.

/// is null. /// /// is less than zero or greater than the length of . /// -or- /// The is not large enough to contain bytes strting /// at the specified . /// /// The logger has been disposed. /// /// An I/O error occurred. ///

public LogClient ( byte buffer, int offset, int count ) : void
buffer	byte	The buffer to log.
offset	int	The offset of the first byte to log.
count	int	The number of bytes to log.
return	void

LogConnect() public method

Logs a connection to the specified URI.

/// is null. /// /// The logger has been disposed. /// /// An I/O error occurred. ///

public LogConnect ( Uri uri ) : void
uri	System.Uri	The URI.
return	void

LogServer() public method

Logs a sequence of bytes sent by the server.

public LogServer ( byte buffer, int offset, int count ) : void
buffer	byte	The buffer to log.
offset	int	The offset of the first byte to log.
count	int	The number of bytes to log.
return	void

ProtocolLogger() public method

Initializes a new instance of the MailKit.ProtocolLogger class.

Creates a new ProtocolLogger to log to a specified stream.

public ProtocolLogger ( Stream stream ) : System
stream	Stream	The stream.
return	System

ProtocolLogger() public method

Initializes a new instance of the MailKit.ProtocolLogger class.

Creates a new ProtocolLogger to log to a specified file.

public ProtocolLogger ( string fileName ) : System
fileName	string	The file name.
return	System