loops/agent/transport/base.py
helmutm e7928f1e32 added docstring and comments to transport.base
git-svn-id: svn://svn.cy55.de/Zope3/src/loops/trunk@1899 fd906abe-77d9-0310-91a1-e0d9ade77398
2007-08-10 07:06:35 +00:00

65 lines
1.7 KiB
Python

#
# Copyright (c) 2007 Helmut Merz helmutm@cy55.de
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
"""
Transporter base classes.
$Id$
"""
from twisted.internet import reactor
from twisted.internet.defer import Deferred
from zope.interface import implements
from loops.agent.interfaces import ITransporter, ITransportJob
from loops.agent.schedule import Job
class TransportJob(Job):
implements(ITransportJob)
def __init__(self, transporter):
super(TransportJob, self).__init__()
self.transporter = transporter
class Transporter(object):
implements(ITransporter)
jobFactory = TransportJob
def __init__(self, agent):
self.agent = agent
def transfer(self, resource):
""" Should be overridden by subclass - this is just an example
how it may look like.
"""
data = resource.data
if type(data) is file:
text = data.read()
data.close()
else:
text = data
metadata = resource.metadata
d = Deferred() # or call something that returns a deferred
return d