Source code

Revision control

Copy as Markdown

Other Tools

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at */
#ifndef nsMailboxProtocol_h___
#define nsMailboxProtocol_h___
#include "mozilla/Attributes.h"
#include "nsMsgProtocol.h"
#include "nsCOMPtr.h"
#include "nsIFile.h"
#include "nsIOutputStream.h"
#include "nsIMailboxUrl.h"
// State Flags (Note, I use the word state in terms of storing
// state information about the connection (authentication, have we sent
// commands, etc. I do not intend it to refer to protocol state)
0x00000001 /* should we pause for the next read */
0x00000002 /* have we read in the first line of the msg */
/* states of the machine
typedef enum _MailboxStatesEnum {
} MailboxStatesEnum;
class nsMsgLineStreamBuffer;
class nsMailboxProtocol : public nsMsgProtocol {
// Creating a protocol instance requires the URL which needs to be run AND it
// requires a transport layer.
explicit nsMailboxProtocol(nsIURI* aURL);
virtual ~nsMailboxProtocol();
// initialization function given a new url and transport layer
nsresult Initialize(nsIURI* aURL);
// the consumer of the url might be something like an nsIDocShell....
virtual nsresult LoadUrl(nsIURI* aURL, nsISupports* aConsumer) override;
// we support the nsIStreamListener interface
NS_IMETHOD OnStartRequest(nsIRequest* request) override;
NS_IMETHOD OnStopRequest(nsIRequest* request, nsresult aStatus) override;
m_runningUrl; // the nsIMailboxURL that is currently running
nsMailboxAction m_mailboxAction; // current mailbox action associated with
// this connection...
// Event sink handles
nsCOMPtr<nsIStreamListener> m_mailboxParser;
// Local state for the current operation
m_lineStreamBuffer; // used to efficiently extract lines from the
// incoming data stream
// Generic state information -- What state are we in? What state do we want to
// go to after the next response? What was the last response code? etc.
MailboxStatesEnum m_nextState;
MailboxStatesEnum m_initialState;
int64_t mCurrentProgress;
// can we just use the base class m_tempMsgFile?
nsCOMPtr<nsIFile> m_tempMessageFile;
nsCOMPtr<nsIOutputStream> m_msgFileOutputStream;
// this is used to hold the source mailbox file open when move/copying
// multiple messages.
nsCOMPtr<nsIInputStream> m_multipleMsgMoveCopyStream;
virtual nsresult ProcessProtocolState(nsIURI* url,
nsIInputStream* inputStream,
uint64_t sourceOffset,
uint32_t length) override;
virtual nsresult CloseSocket() override;
nsresult OpenMultipleMsgTransport(uint64_t offset, int64_t size);
bool RunningMultipleMsgUrl();
// Protocol Methods --> This protocol is state driven so each protocol method
// is designed to re-act to the current "state". I've attempted to
// group them together based on functionality.
// When parsing a mailbox folder in chunks, this protocol state reads in the
// current chunk and forwards it to the mailbox parser.
int32_t ReadFolderResponse(nsIInputStream* inputStream, uint64_t sourceOffset,
uint32_t length);
int32_t ReadMessageResponse(nsIInputStream* inputStream,
uint64_t sourceOffset, uint32_t length);
nsresult DoneReadingMessage();
// End of Protocol Methods
#endif // nsMailboxProtocol_h___