1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 """interfaces used by flumotion
23 """
24
25 from zope.interface import Attribute, Interface
26
27 __version__ = "$Rev: 7162 $"
28
29
30
31
32
34 """I am a base interface for PB client-side mediums interfacing with
35 manager-side avatars.
36 """
37
39 """Set the RemoteReference to the manager-side avatar.
40 @param remoteReference: L{twisted.spread.pb.RemoteReference}
41 """
42
44 """Check if we have a remote reference to the PB server's avatar.
45 @returns: True if we have a remote reference
46 """
47
49 """Call a method through the remote reference to the
50 manager-side avatar.
51 @param name: name of remote method
52 """
53
54
56 """I am an interface for component-side mediums interfacing
57 with server-side avatars.
58 """
59
60
62 """An interface for streaming components, for plugs that
63 require a streaming component of some sort to use.
64 """
65
67 """Return a URL that the streaming component is streaming.
68 """
69
71 """Return a description of the stream from this component.
72 """
73
74
76 """I am an interface for admin-side mediums interfacing with manager-side
77 avatars.
78 """
79
80
82 """I am an interface for worker-side mediums interfacing with manager-side
83 avatars.
84 """
85
86
88 """I am an interface for porter client mediums interfacing with the porter.
89 """
90
91
93 """I am an interface for job-side mediums interfacing with worker-side
94 avatars.
95 """
96
97
99 """I am an interface for mediums in a job or manager interfacing with feed
100 avatars.
101 """
102
103
105 """My implementors manage avatars logging in to the manager.
106 """
107
109 """Creates a new avatar matching the type of heaven.
110 @param avatarId:
111 @type avatarId: string
112 @returns: the avatar from the matching heaven for a new object.
113 """
114
116 """Remove the avatar with the given Id from the heaven.
117 """
118
119
121 """I am an interface for objects that manage a FeedServer, allowing the
122 FeedServer to hand off file descriptors to eaters and feeders managed
123 by the parent.
124 """
125
126 - def feedToFD(componentId, feedName, fd):
127 """Make the component feed the given feed to the fd.
128 @param componentId:
129 @param feedName: a feed name
130 @param fd: a file descriptor
131 """
132
133
135 """I am an interface representing a file and it's metadata.
136 """
137 filename = Attribute('the name of the file')
138 iconNames = Attribute("""icon names that should be used to represent
139 this file in a graphical interface""")
140
142 """Returns the complete path to the file, including
143 the filename itself.
144 @returns: the complete path to the file
145 @rtype: str
146 """
147
148
150 """I am an interface representing a directory and it's metadata.
151 I extend the IFile interface.
152 To list files of a certain directory you first need to call
153 L{flumotion.common.vfs.listDirectory}, which will return
154 an object implementing this interface.
155 """
156
158 """Fetches all the files in the directory specified.
159 @returns: list of files
160 @rtype: a deferred firing a list of objects implementing L{IFile}.
161 """
162