[mnet-devel] simpler protocols
Zooko Journeyman
zooko at zooko.com
Tue Oct 21 17:15:38 BST 2003
I'm including below the current text of mnet/common/OurMessages.py. It is
fairly short, not hard to read, and after you've read it then you understand
the contents of all messages that are sent between nodes in the current Mnet
network (comprising both v0.6.2.231-STABLE and v0.7.0.61-UNSTABLE nodes).
After that, I'm including the entire text of what was in
mnet/common/OurMessages.py before the big backwards-incompatible protocol
cleanup that I just committed. You will see that it was not so simple back
then.
Regards,
Zooko
####### The current version of OurMessages.py:
# Block Server messages
templs['do you have blocks'] = ListMarker(UNIQUE_ID)
templs['do you have blocks response'] = ListMarker(UNIQUE_ID)
templs['request block'] = UNIQUE_ID
templs['request block response'] = [
{'result': "success", 'data': ANY},
{'result': "failure"},
]
templs['put block'] = {'blockId': UNIQUE_ID, 'data': ANY}
templs['put block response'] = [
{'result': "success"},
{'result': "failure"}
]
# Relay Server messages
templs['pass this along'] = {'recipientId': UNIQUE_ID, 'message': STRING}
templs['pass this along response'] = [
{'result': "success"},
{'result': "failure", 'reason': STRING}
]
templs['are there messages'] = None
templs['are there messages response'] = ListMarker(STRING)
templs['message for you'] = STRING
templs['message for you response'] = [
{'result': "success"},
{'result': "failure"}
]
# Content Tracker messages
templs['content tracker lookup'] = {'XML data': ANY, 'first ISO date': OptionMarker(STRING), 'last ISO date': OptionMarker(STRING)}
templs['content tracker lookup response'] = [
{'result': "success", 'list': ListMarker(STRING)},
{'result': "failure", 'reason': STRING}
]
templs['content tracker submit'] = {'XML data': ANY}
templs['content tracker submit response'] = {'result': ['success', 'failure'],
templs['content tracker submit response'] = [
{'result': "success", 'mojoid': UNIQUE_ID},
{'result': "failure", 'reason': STRING}
]
# Meta Tracker messages
SERVICE_TEMPLS = [
{'type': "block server", 'publishing allowed': BOOLEAN}
{'type': "meta tracker"}
{'type': "content tracker",}
{'type': "relay server"}
]
PHONEBOOK_ENTRY = {
'connection strategies': ListMarker(CRYPTO_COMM_STRAT_TEMPL),
'services': OptionMarker(SERVICE_TEMPLS),
'sequence num': OptionMarker(NON_NEGATIVE_INTEGER),
'result': OptionMarker("success"),
}
templs['lookup contact info'] = {'nodeId': UNIQUE_ID}
templs['lookup contact info response'] = [
{'result': "failure"},
PHONEBOOK_ENTRY,
]
templs['hello'] = PHONEBOOK_ENTRY
templs['hello response'] = [
{'result': 'success'},
{'result': 'failure', 'reason': STRING}
]
templs['goodbye'] = None
####### The previous version of OurMessages.py:
templs['do you have blocks'] = {'block id list': ListMarker(UNIQUE_ID), 'do not recurse': OptionMarker("true")}
templs['do you have blobs'] = templs['do you have blocks'] # "do you have blocks" is the way it will be spelled in the future, "do you have blobs" is the way it was spelled in the past.
# Include 'do not recurse: true' when doing block wholesaling. Else, leave it off.
templs['do you have blocks response'] = ListMarker(UNIQUE_ID)
templs['do you have blobs response'] = templs['do you have blocks response']
templs['request block'] = {'blockId': OptionMarker(UNIQUE_ID), 'blob id': OptionMarker(UNIQUE_ID), 'do not recurse': OptionMarker("true")}
templs['request blob'] = templs['request block'] # "request block" is the way it will be spelled in the future, "request blob" is the way it was spelled in the past.
templs['request block response'] = [{'result': "success", 'data': ANY}, {'result': "failure"}]
templs['request blob response'] = templs['request block response']
templs['put block'] = {'blockId': OptionMarker(UNIQUE_ID), 'blob id': OptionMarker(UNIQUE_ID), 'data': ANY, 'passalong': OptionMarker(0)}
templs['put blob'] = templs['put block'] # "put block" is the way it will be spelled in the future, "put blob" is the way it was spelled in the past.
templs['put block response'] = {'result': ["success", "failure"]}
templs['put blob response'] = templs['put block response']
IDMASK_TEMPL={'mask': ASCII_ARMORED_DATA, 'bits': NON_NEGATIVE_INTEGER} # deprecated long ago, and probably safely removable? --Zooko 2003-02-08
# Relay Server messages
#
MT=[{'message': STRING}, STRING] # An "MT" is either a string (preferred new form) or a dict with key 'message' and value string (deprecated old form).
LMT=[{'messages': ListMarker(MT)}, ListMarker(MT), {'messages attached': ListMarker(MT)}, {'messages attached v2': ListMarker(MT)}] # An "LMT" is either a sequence of MTs (preferred new form) or a dict with key 'messages' and value a sequence of MTs (deprecated old form).
BUNDLED_MESSAGES_TEMPL = LMT
templs['pass this along v2'] = { 'recipient': UNIQUE_ID, 'message': STRING}
templs['pass this along v2 response'] = [{ 'result': "success" }, { 'result': "ok" }, { 'result': "failure", 'reason': STRING }] # XXX It would be nice to change this to be "success" instead of "ok" in order to be consistent with all our other response messages. I'm writing code from now on that accepts either. --Zooko 2001-05-05
templs['are there messages v2'] = {'response version': OptionMarker(1)}
templs['are there messages v2 response'] = [
{'result' : 'no'},
{'result': 'yes', 'number of messages': NON_NEGATIVE_INTEGER, 'total bytes': NON_NEGATIVE_INTEGER, 'messages info': OptionMarker(ListMarker({'sender id': UNIQUE_ID, 'message id': UNIQUE_ID, 'length': 0}))},
BUNDLED_MESSAGES_TEMPL,
ListMarker([BUNDLED_MESSAGES_TEMPL, {'result' : 'no'}, {'result': 'yes', 'number of messages': NON_NEGATIVE_INTEGER, 'total bytes': NON_NEGATIVE_INTEGER, 'messages info': OptionMarker(ListMarker({'sender id': UNIQUE_ID, 'message id': UNIQUE_ID, 'length': 0}))}, INTEGER, 0]), # This is for backwards compatibility with a bug present up to version: v0.6.1.174-UNSTABLE (including up to v0.6.0.154-STABLE).
]
templs['retrieve messages v2'] = [{'messages': OptionMarker(ListMarker({'sender id': UNIQUE_ID, 'message id': UNIQUE_ID, 'length': 0}))}]
templs['retrieve messages v2 response'] = [
{'status': 'no messages'},
BUNDLED_MESSAGES_TEMPL,
ListMarker([{'status': 'no messages'}, BUNDLED_MESSAGES_TEMPL, INTEGER, 0]), # This is for backwards compatibility with a bug present up to version: v0.6.1.174-UNSTABLE (including up to v0.6.0.154-STABLE).
]
# Let's take the " v2" off of these names... --Zooko 2001-09-04
for relaymtype in ['pass this along', 'are there messages', 'retrieve messages']:
templs[relaymtype] = templs[relaymtype + ' v2']
templs[relaymtype + ' response'] = templs[relaymtype + ' v2 response']
# These are used in fast-relay for a relay server to directly send a message to
# a counterparty down an open connection.
templs['message for you'] = MT
templs['message for you response'] = {'result': ["success", "failure"]}
# Used by content trackers and for talking to content trackers. data
# is in a content tracker specific format (generally XML or a signed
# SEXP containing XML?)
#
templs['content tracker lookup'] = {'XML data': ANY, 'first ISO date': OptionMarker(STRING), 'last ISO date': OptionMarker(STRING)}
# 'result' will be either "success" or "failure". There will be a 'list' field on all "success" responses.
templs['content tracker lookup response'] = {'result': ['success', 'failure', 'no match'], 'list': OptionMarker(ListMarker(STRING)), 'verifier': OptionMarker(["yes", "no"])}
templs['content tracker submit'] = {'XML data': ANY}
templs['content tracker submit response'] = {'result': ['success', 'failure'], 'mojoid': OptionMarker(ASCII_ID)}
templs['download content types'] = {}
templs['download content types response'] = ListMarker(STRING)
# 'hello' and 'hello response' are used for any EGTP agent to contact any other in order to
# establish its id and the connection strategy (i.e. its IP number or whatever).
templs['hello'] = {'connection strategies': ListMarker({}), 'sequence num': 0, 'seconds to live': OptionMarker(0)}
templs['hello response'] = {'result': ["success", "failure"]}
templs['goodbye'] = {}
## BadBlockListSubcriber messages:
templs['get bad block list'] = [
{}, # The server considers the client a brand new client.
{'nonce': UNIQUE_ID, # If this doesn't match the server's nonce, the server treats the client as a brand new client (start and end are ignored!)
'start': OptionMarker(NON_NEGATIVE_INTEGER), # If this is absent, 0 is used. (The list in the response message has a max size, though.)
'end': OptionMarker(NON_NEGATIVE_INTEGER), # If this is omitted, the end of the server's list is used.
}]
templs['get bad block list response'] = [
{
'result': 'success',
'nonce': UNIQUE_ID, # This is always the server's current nonce. If it doesn't match the clients nonce, the client should notice the discrepancy.
'start': NON_NEGATIVE_INTEGER, # This is the true starting index on the server side (which might be different than what the client asked for).
'end': NON_NEGATIVE_INTEGER, # This is the true ending index on the server side (which might be different than what the client asked for).
'bad block list': ListMarker(UNIQUE_ID), # These are blockIds.
}, {
'result': 'failure',
'failure reason': OptionMarker(STRING),
}]
# type is one of 'blob server', 'content tracker', 'meta tracker', 'relay server v2'
HELLO_SERVICE_TEMPL={ 'type': STRING } # don't be explicit here, that would disallow experimental and future services
# These are templates for service descriptions within hello messages
#
HELLO_SERVICE_BLOCK_SERVER_TEMPL={ 'type': "block server", 'publishing allowed': BOOLEAN, 'mask list': OptionMarker(ListMarker(IDMASK_TEMPL)), 'stddev': OptionMarker(NON_NEGATIVE_INTEGER), 'centerpoint': OptionMarker(NON_NEGATIVE_INTEGER)}
HELLO_SERVICE_BLOB_SERVER_TEMPL={ 'type': "blob server", 'publishing allowed': BOOLEAN, 'mask list': OptionMarker(ListMarker(IDMASK_TEMPL)), 'stddev': OptionMarker(NON_NEGATIVE_INTEGER), 'centerpoint': OptionMarker(NON_NEGATIVE_INTEGER)}
HELLO_SERVICE_META_TRACKER_TEMPL={ 'type': "meta tracker", 'seconds until expiration': NON_NEGATIVE_INTEGER}
HELLO_SERVICE_CONTENT_TRACKER_TEMPL={ 'type': "content tracker", 'content types': OptionMarker(ListMarker(ANY)), 'supports smart queries': OptionMarker('yes')}
HELLO_SERVICE_RELAY_SERVER_TEMPL={ 'type': ["relay server v2", "relay server"]}
####
# The MetaTracker uses this for checking service templates of received hello messages. If a service type isn't
# a key in this dict, the MetaTracker won't accept it.
#
HELLO_SERVICE_TEMPL_TYPE_MAP = {
'blob server' : HELLO_SERVICE_BLOB_SERVER_TEMPL,
'block server' : HELLO_SERVICE_BLOCK_SERVER_TEMPL,
'meta tracker' : HELLO_SERVICE_META_TRACKER_TEMPL,
'content tracker' : HELLO_SERVICE_CONTENT_TRACKER_TEMPL,
'relay server v2' : HELLO_SERVICE_RELAY_SERVER_TEMPL,
'relay server' : HELLO_SERVICE_RELAY_SERVER_TEMPL,
}
templs['lookup contact info'] = { 'key id': UNIQUE_ID }
PHONEBOOK_ENTRY = {
'connection strategies': ListMarker(CRYPTO_COMM_STRAT_TEMPL),
'services': OptionMarker(ListMarker([ANY, None]))
}
# XXX specify the templates for services. --Zooko 2000-08-01
# XXXX Greg: is the services value just a list of HELLO_SERVICE_TEMPL_TYPE_MAPS? --Zooko 2000-08-01
# We need to leave the ANY in this template for now because the software needs to throw items in the list
# away on an individual basis rather than the message as a whole within MetaTrackerLib. Other newer
# software could be out there advertising a whole new service type that would fail the template check if
# it weren't for the ANY. -greg 2000-09-04
# Example: ListMarker( HELLO_SERVICE_TEMPL_TYPE_MAPS.values() ) will not work into the future as desired
# because new service types would cause a template check failure. -greg 2000-09-04
# NOTE: MetaTrackerLib is already intelligently template checking service entries based on their type.
templs['lookup contact info response'] = [
{ 'result': "failure" },
{ 'result': "success",
'connection strategies': ListMarker(CRYPTO_COMM_STRAT_TEMPL),
'services': OptionMarker(ListMarker([ANY, None])),
'sequence num': OptionMarker(0),
'seconds to live': OptionMarker(0),
}
]
templs['list relay servers v2'] = {}
templs['list relay servers'] = templs['list relay servers v2']
# templs['list relay servers v2 response'] = ListMarker({
# 'connection strategies': ListMarker(CRYPTO_COMM_STRAT_TEMPL),
# 'services': OptionMarker(ListMarker(ANY))})
-------------------------------------------------------
This SF.net email is sponsored by OSDN developer relations
Here's your chance to show off your extensive product knowledge
We want to know what you know. Tell us and you have a chance to win $100
http://www.zoomerang.com/survey.zgi?HRPT1X3RYQNC5V4MLNSV3E54
_______________________________________________
mnet-devel mailing list
mnet-devel at lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/mnet-devel
More information about the Mnet-devel
mailing list