PageRenderTime 6ms CodeModel.GetById 2ms app.highlight 1ms RepoModel.GetById 2ms app.codeStats 0ms

/core/externals/update-engine/Core/KSOutOfBandDataAction.h

http://macfuse.googlecode.com/
C++ Header | 49 lines | 10 code | 6 blank | 33 comment | 0 complexity | eacf814c3eab966c62e5788aa7f0c0ae MD5 | raw file
 1// Copyright 2010 Google Inc.
 2//
 3// Licensed under the Apache License, Version 2.0 (the "License");
 4// you may not use this file except in compliance with the License.
 5// You may obtain a copy of the License at
 6//
 7//     http://www.apache.org/licenses/LICENSE-2.0
 8//
 9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15#import <Foundation/Foundation.h>
16#import "KSAction.h"
17
18@class KSUpdateEngine;
19
20// KSOutOfBandDataAction
21//
22// A KSAction that reports any out-of-band data to the Update Engine
23// delegate.
24//
25// It expects in its in-pipe a dictionary containing two items:
26//  - UpdateInfos : NSArray of KSUpdateInfos
27//  - OutOfBandData : NSDictionary of OOB data, keyed by server URL.
28// The contents of the OOB data are server-dependent.
29//
30// If there is out-of-band data, it calls the Update Engine delegate's
31// -engine:hasOutOfBandData: method.
32//
33// The action emits the UpdateInfos array to its out-pipe.  If the incoming
34// data is not a dictionary, this action just passes the inPipe value out
35// to the outPipe.
36//
37@interface KSOutOfBandDataAction : KSAction {
38 @private
39  KSUpdateEngine *engine_;
40}
41
42// Returns an autoreleased KSOutOfBandDataAction associated with |engine|.
43+ (id)actionWithEngine:(KSUpdateEngine *)engine;
44
45// Designated initializer. Returns a KSOutOfBandDataAction associated
46// with |engine|
47- (id)initWithEngine:(KSUpdateEngine *)engine;
48
49@end