Source code

Revision control

Copy as Markdown

Other Tools

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set sw=2 ts=8 et tw=80 ft=cpp : */
/* 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 http://mozilla.org/MPL/2.0/. */
include protocol PNecko;
include InputStreamParams;
include PBackgroundSharedTypes;
include NeckoChannelParams;
include IPCServiceWorkerDescriptor;
include IPCStream;
include HttpChannelParams;
include "mozilla/dom/ReferrerInfoUtils.h";
include "mozilla/net/NeckoMessageUtils.h";
include "mozilla/net/ClassOfService.h";
using mozilla::OriginAttributes from "mozilla/ipc/BackgroundUtils.h";
using mozilla::net::ClassOfService from "mozilla/net/ClassOfService.h";
[RefCounted] using class nsIURI from "mozilla/ipc/URIUtils.h";
namespace mozilla {
namespace net {
//-------------------------------------------------------------------
[ChildImpl=virtual, ParentImpl=virtual]
protocol PHttpChannel
{
manager PNecko;
parent:
// Note: channels are opened during construction, so no open method here:
// see PNecko.ipdl
async SetClassOfService(ClassOfService cos);
async Suspend();
async Resume();
async Cancel(nsresult status, uint32_t requestBlockingReason,
nsCString aReason, nsCString? logString);
// Reports approval/veto of redirect by child process redirect observers
async Redirect2Verify(nsresult result, RequestHeaderTuples changedHeaders,
uint32_t sourceRequestBlockingReason,
ChildLoadInfoForwarderArgs? targetLoadInfoForwarder,
uint32_t loadFlags,
nullable nsIReferrerInfo referrerInfo,
nullable nsIURI apiRedirectTo,
CorsPreflightArgs? corsPreflightArgs);
// For document loads we keep this protocol open after child's
// OnStopRequest, and send this msg (instead of __delete__) to allow
// partial cleanup on parent.
async DocumentChannelCleanup(bool clearCacheEntry);
// Child has detected a CORS check failure, so needs to tell the parent
// to remove any matching entry from the CORS preflight cache.
async RemoveCorsPreflightCacheEntry(nullable nsIURI uri,
PrincipalInfo requestingPrincipal,
OriginAttributes originAttributes);
// Send cookies to the parent for a given channel. Compared to PCookieService
// SetCookies this method allows the parent to determine which BrowsingContext
// the request was sent for.
async SetCookies(nsCString baseDomain,
OriginAttributes attrs,
nullable nsIURI host,
bool fromHttp,
bool isThirdParty,
CookieStruct[] cookies);
// After receiving this message, the parent calls SendDeleteSelf, and makes
// sure not to send any more messages after that.
async DeletingChannel();
// Called to get the input stream when altData was delivered.
async OpenOriginalCacheInputStream();
// Tell the parent the amount bytes read by child for the e10s back pressure
// flow control
async BytesRead(int32_t count);
async __delete__();
child:
// Used to cancel child channel if we hit errors during creating and
// AsyncOpen of nsHttpChannel on the parent.
async FailedAsyncOpen(nsresult status);
// OnStartRequest is sent over PHttpBackgroundChannel. However, sometime we
// need to wait for some PContent IPCs, e.g., permission, cookies. Those IPC
// are sent just before the background thread OnStartRequest, which is racy.
// Therefore, need one main thread IPC event for synchronizing the event
// sequence.
async OnStartRequestSent();
// Called to initiate content channel redirect, starts talking to sinks
// on the content process and reports result via Redirect2Verify above
async Redirect1Begin(uint32_t registrarId,
nullable nsIURI newOriginalUri,
uint32_t newLoadFlags,
uint32_t redirectFlags,
ParentLoadInfoForwarderArgs loadInfoForwarder,
nsHttpResponseHead responseHead,
nullable nsITransportSecurityInfo securityInfo,
uint64_t channelId,
NetAddr oldPeerAddr,
ResourceTimingStructArgs timing);
// Called if redirect successful so that child can complete setup.
async Redirect3Complete();
// Called if the redirect failed/was vetoed
async RedirectFailed(nsresult status);
// Report a security message to the console associated with this
// channel.
async ReportSecurityMessage(nsString messageTag, nsString messageCategory);
// Tell child to delete channel (all IPDL deletes must be done from child to
// avoid races: see bug 591708).
async DeleteSelf();
// When CORS blocks the request in the parent process, it doesn't have the
// correct window ID, so send the message to the child for logging to the web
// console.
async LogBlockedCORSRequest(nsString message,
nsCString category,
bool isWarning);
async LogMimeTypeMismatch(nsCString messageName,
bool warning,
nsString url,
nsString contentType);
async OriginalCacheInputStreamAvailable(IPCStream? stream);
both:
async SetPriority(int16_t priority);
};
} // namespace net
} // namespace mozilla