Repository URL to install this package:
|
Version:
2.10.3 ▾
|
Ý docutils.nodesdocument)}( rawsource children]h section)}(hhh](h title)}(hMessageh]h TextMessage
}(parenth _documenthsourceNlineNuba
attributes}(ids]classes]names]dupnames]backrefs]utagnamehhhhhh;/home/jforcier/Code/oss/paramiko/sites/docs/api/message.rsthKubsphinx.addnodesindex)}(hhh]h}(h ]h"]h$]h&]h(]entries](singleparamiko.message (module)module-paramiko.messagehNtauh*h-hhhhhR/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.messagehKubh paragraph)}(h$Implementation of an SSH2 "message".h]h(Implementation of an SSH2 “message”.
}(hhAhhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hR/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.messagehKhhhhubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:#Message (class in paramiko.message)paramiko.message.MessagehNtauh*h-hhhhhNhNubh,desc)}(hhh](h,desc_signature)}(hMessage(content=None)h](h,desc_annotation)}(hclass h]hclass
}(hhkhhhNhNubah}(h ]h"]h$]h&]h(] xml:spacepreserveuh*hihhehhhZ/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.MessagehNubh,desc_addname)}(hparamiko.message.h]hparamiko.message.
}(hh~hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*h|hhehhhh{hNubh, desc_name)}(hMessageh]hMessage
}(hhhhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhhehhhh{hNubh,desc_parameterlist)}(hcontent=Noneh]h,desc_parameter)}(hcontent=Noneh]hcontent=None
}(hh¤hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*h¢hhubah}(h ]h"]h$]h&]h(]hyhzuh*hhhehhhh{hNubeh}(h ]h\ah"]h$]h\ah&]h(]firstmoduleparamiko.messageclasshfullnamehuh*hchh`hhhh{hNubh,desc_content)}(hhh](h@)}(hÑAn SSH2 message is a stream of bytes that encodes some combination of
strings, integers, bools, and infinite-precision integers (known in Python
as longs). This class builds or breaks down such a byte stream.h]hÑAn SSH2 message is a stream of bytes that encodes some combination of
strings, integers, bools, and infinite-precision integers (known in Python
as longs). This class builds or breaks down such a byte stream.
}(hhÈhhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hZ/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.MessagehKhhÅhhubh@)}(h¨Normally you don't need to deal with anything this low-level, but it's
exposed for people implementing custom extensions, or features that
paramiko doesn't support yet.h]h®Normally you don’t need to deal with anything this low-level, but it’s
exposed for people implementing custom extensions, or features that
paramiko doesn’t support yet.
}(hh×hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hhÖhKhhÅhhubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:,__init__() (paramiko.message.Message method)!paramiko.message.Message.__init__hNtauh*h-hhÅhhhNhNubh_)}(hhh](hd)}(hMessage.__init__(content=None)h](h)}(h__init__h]h__init__
}(hhúhhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhhöhhhc/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.__init__hNubh)}(hcontent=Noneh]h£)}(hcontent=Noneh]hcontent=None
}(hj
hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*h¢hj ubah}(h ]h"]h$]h&]h(]hyhzuh*hhhöhhhj hNubeh}(h ]hñah"]h$]hñah&]h(]h¾h¿paramiko.messagehÁhhMessage.__init__uh*hchhóhhhj hNubhÄ)}(hhh](h@)}(hCreate a new SSH2 message.h]hCreate a new SSH2 message.
}(hj, hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hc/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.__init__hKhj) hhubh
field_list)}(hhh]h field)}(hhh](h
field_name)}(h
Parametersh]h
Parameters
}(hjG hhhNhNubah}(h ]h"]h$]h&]h(]uh*jE hjB hj hK ubh
field_body)}(hhh]h@)}(hkcontent (str) -- the byte stream to use as the message content (passed in only when
decomposing a message).h](h,literal_strong)}(hcontenth]hcontent
}(hj` hhhNhNubah}(h ]h"]h$]h&]h(]refspecificuh*j^ hjZ ubh (
}(hjZ hhhNhNubh,pending_xref)}(hhh]h,literal_emphasis)}(hstrh]hstr
}(hjz hhhNhNubah}(h ]h"]h$]h&]h(]uh*jx hju ubah}(h ]h"]h$]h&]h(] refdomainpyrefexplicitreftypeobj reftargetj| jn uh*js hjZ ubh)
}(hjZ hhhNhNubh –
}(hjZ hhhNhNubhZthe byte stream to use as the message content (passed in only when
decomposing a message).
}(hjZ hhhNhNubeh}(h ]h"]h$]h&]h(]uh*h?hjW ubah}(h ]h"]h$]h&]h(]uh*jU hjB ubeh}(h ]h"]h$]h&]h(]uh*j@ hj= ubah}(h ]h"]h$]h&]h(]uh*j; hj) hhhNhNubeh}(h ]h"]h$]h&]h(]uh*hÃhhóhhhj hNubeh}(h ]h"]h$]h&]h(]domainj objtypemethoddesctypejÆ noindexuh*h^hhhhÅhNhNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:,__repr__() (paramiko.message.Message method)!paramiko.message.Message.__repr__hNtauh*h-hhÅhhhc/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.__repr__hNubh_)}(hhh](hd)}(hMessage.__repr__()h](h)}(h__repr__h]h__repr__
}(hjß hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhjÛ hhhc/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.__repr__hNubh)}(hhh]h}(h ]h"]h$]h&]h(]hyhzuh*hhjÛ hhhjí hNubeh}(h ]jÕ ah"]h$]jÕ ah&]h(]h¾h¿paramiko.messagehÁhhMessage.__repr__uh*hchjØ hhhjí hNubhÄ)}(hhh]h@)}(h>Returns a string representation of this object, for debugging.h]h>Returns a string representation of this object, for debugging.
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hj× hKhjÿ hhubah}(h ]h"]h$]h&]h(]uh*hÃhjØ hhhjí hNubeh}(h ]h"]h$]h&]h(]jÄ pyjÅ methodjÇ j jÈ uh*h^hhhhÅhj× hNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:+__str__() (paramiko.message.Message method) paramiko.message.Message.__str__hNtauh*h-hhÅhhhb/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.__str__hNubh_)}(hhh](hd)}(hMessage.__str__()h](h)}(h__str__h]h__str__
}(hj4 hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhj0 hhhb/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.__str__hNubh)}(hhh]h}(h ]h"]h$]h&]h(]hyhzuh*hhj0 hhhjB hNubeh}(h ]j* ah"]h$]j* ah&]h(]h¾h¿paramiko.messagehÁhhMessage.__str__uh*hchj- hhhjB hNubhÄ)}(hhh]h@)}(hFReturn the byte stream content of this message, as a string/bytes obj.h]hFReturn the byte stream content of this message, as a string/bytes obj.
}(hjW hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hj, hKhjT hhubah}(h ]h"]h$]h&]h(]uh*hÃhj- hhhjB hNubeh}(h ]h"]h$]h&]h(]jÄ pyjÅ methodjÇ jr jÈ uh*h^hhhhÅhj, hNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:0__weakref__ (paramiko.message.Message attribute)$paramiko.message.Message.__weakref__hNtauh*h-hhÅhhhf/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.__weakref__hNubh_)}(hhh](hd)}(hMessage.__weakref__h]h)}(h__weakref__h]h__weakref__
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhj
hhhf/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.__weakref__hNubah}(h ]j ah"]h$]j ah&]h(]h¾h¿paramiko.messagehÁhhMessage.__weakref__uh*hchj hhhj hNubhÄ)}(hhh]h@)}(h2list of weak references to the object (if defined)h]h2list of weak references to the object (if defined)
}(hj£ hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hj hKhj hhubah}(h ]h"]h$]h&]h(]uh*hÃhj hhhj hNubeh}(h ]h"]h$]h&]h(]jÄ pyjÅ attributejÇ j¾ jÈ uh*h^hhhhÅhj hNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:'add() (paramiko.message.Message method)paramiko.message.Message.addhNtauh*h-hhÅhhhNhNubh_)}(hhh](hd)}(hMessage.add(*seq)h](h)}(haddh]hadd
}(hjÔ hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhjÐ hhh^/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.addhNubh)}(h*seqh]h£)}(h*seqh]h*seq
}(hjç hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*h¢hjã ubah}(h ]h"]h$]h&]h(]hyhzuh*hhjÐ hhhjâ hNubeh}(h ]jË ah"]h$]jË ah&]h(]h¾h¿paramiko.messagehÁhhMessage.adduh*hchjÍ hhhjâ hNubhÄ)}(hhh](h@)}(hrAdd a sequence of items to the stream. The values are encoded based
on their type: str, int, bool, list, or long.h]hrAdd a sequence of items to the stream. The values are encoded based
on their type: str, int, bool, list, or long.
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?h^/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.addhKhj hhubh warning)}(h@Longs are encoded non-deterministically. Don't use this method.h]h@)}(hj h]hBLongs are encoded non-deterministically. Don’t use this method.
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hj hKhj ubah}(h ]h"]h$]h&]h(]uh*j hj hhhj hNubj< )}(hhh]jA )}(hhh](jF )}(h
Parametersh]h
Parameters
}(hj4 hhhNhNubah}(h ]h"]h$]h&]h(]uh*jE hj1 hjâ hK ubjV )}(hhh]h@)}(hseq -- the sequence of itemsh](j_ )}(hseqh]hseq
}(hjI hhhNhNubah}(h ]h"]h$]h&]h(]jn uh*j^ hjE ubh –
}(hjE hhhNhNubhthe sequence of items
}(hjE hhhNhNubeh}(h ]h"]h$]h&]h(]uh*h?hjB ubah}(h ]h"]h$]h&]h(]uh*jU hj1 ubeh}(h ]h"]h$]h&]h(]uh*j@ hj. ubah}(h ]h"]h$]h&]h(]uh*j; hj hhhNhNubeh}(h ]h"]h$]h&]h(]uh*hÃhjÍ hhhjâ hNubeh}(h ]h"]h$]h&]h(]jÄ pyjÅ methodjÇ j jÈ uh*h^hhhhÅhNhNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:4add_adaptive_int() (paramiko.message.Message method))paramiko.message.Message.add_adaptive_inthNtauh*h-hhÅhhhNhNubh_)}(hhh](hd)}(hMessage.add_adaptive_int(n)h](h)}(hadd_adaptive_inth]hadd_adaptive_int
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhj hhhk/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.add_adaptive_inthNubh)}(hnh]h£)}(hnh]hn
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*h¢hj© ubah}(h ]h"]h$]h&]h(]hyhzuh*hhj hhhj¨ hNubeh}(h ]j ah"]h$]j ah&]h(]h¾h¿paramiko.messagehÁhhMessage.add_adaptive_intuh*hchj hhhj¨ hNubhÄ)}(hhh](h@)}(hAdd an integer to the stream.h]hAdd an integer to the stream.
}(hjÌ hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hk/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.add_adaptive_inthKhjÉ hhubj< )}(hhh]jA )}(hhh](jF )}(h
Parametersh]h
Parameters
}(hjá hhhNhNubah}(h ]h"]h$]h&]h(]uh*jE hjÞ hj¨ hK ubjV )}(hhh]h@)}(hn (int) -- integer to addh](j_ )}(hj¯ h]hn
}(hjö hhhNhNubah}(h ]h"]h$]h&]h(]jn uh*j^ hjò ubh (
}(hjò hhhNhNubjt )}(hhh]jy )}(hinth]hint
}(hj
hhhNhNubah}(h ]h"]h$]h&]h(]uh*jx hj ubah}(h ]h"]h$]h&]h(] refdomainpyrefexplicitreftypej reftargetj jn uh*js hjò ubh)
}(hjò hhhNhNubh –
}(hjò hhhNhNubhinteger to add
}(hjò hhhNhNubeh}(h ]h"]h$]h&]h(]uh*h?hjï ubah}(h ]h"]h$]h&]h(]uh*jU hjÞ ubeh}(h ]h"]h$]h&]h(]uh*j@ hjÛ ubah}(h ]h"]h$]h&]h(]uh*j; hjÉ hhhNhNubeh}(h ]h"]h$]h&]h(]uh*hÃhj hhhj¨ hNubeh}(h ]h"]h$]h&]h(]jÄ j jÅ methodjÇ jS jÈ uh*h^hhhhÅhNhNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:/add_boolean() (paramiko.message.Message method)$paramiko.message.Message.add_booleanhNtauh*h-hhÅhhhNhNubh_)}(hhh](hd)}(hMessage.add_boolean(b)h](h)}(hadd_booleanh]hadd_boolean
}(hji hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhje hhhf/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.add_booleanhNubh)}(hbh]h£)}(hbh]hb
}(hj| hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*h¢hjx ubah}(h ]h"]h$]h&]h(]hyhzuh*hhje hhhjw hNubeh}(h ]j` ah"]h$]j` ah&]h(]h¾h¿paramiko.messagehÁhhMessage.add_booleanuh*hchjb hhhjw hNubhÄ)}(hhh](h@)}(h"Add a boolean value to the stream.h]h"Add a boolean value to the stream.
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hf/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.add_booleanhKhj hhubj< )}(hhh]jA )}(hhh](jF )}(h
Parametersh]h
Parameters
}(hj° hhhNhNubah}(h ]h"]h$]h&]h(]uh*jE hj hjw hK ubjV )}(hhh]h@)}(h b (bool) -- boolean value to addh](j_ )}(hj~ h]hb
}(hjÅ hhhNhNubah}(h ]h"]h$]h&]h(]jn uh*j^ hjÁ ubh (
}(hjÁ hhhNhNubjt )}(hhh]jy )}(hboolh]hbool
}(hjÙ hhhNhNubah}(h ]h"]h$]h&]h(]uh*jx hjÖ ubah}(h ]h"]h$]h&]h(] refdomainpyrefexplicitreftypej reftargetjÛ jn uh*js hjÁ ubh)
}(hjÁ hhhNhNubh –
}(hjÁ hhhNhNubhboolean value to add
}(hjÁ hhhNhNubeh}(h ]h"]h$]h&]h(]uh*h?hj¾ ubah}(h ]h"]h$]h&]h(]uh*jU hj ubeh}(h ]h"]h$]h&]h(]uh*j@ hjª ubah}(h ]h"]h$]h&]h(]uh*j; hj hhhNhNubeh}(h ]h"]h$]h&]h(]uh*hÃhjb hhhjw hNubeh}(h ]h"]h$]h&]h(]jÄ jî jÅ methodjÇ j" jÈ uh*h^hhhhÅhNhNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:,add_byte() (paramiko.message.Message method)!paramiko.message.Message.add_bytehNtauh*h-hhÅhhhNhNubh_)}(hhh](hd)}(hMessage.add_byte(b)h](h)}(hadd_byteh]hadd_byte
}(hj8 hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhj4 hhhc/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.add_bytehNubh)}(hbh]h£)}(hj~ h]hb
}(hjK hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*h¢hjG ubah}(h ]h"]h$]h&]h(]hyhzuh*hhj4 hhhjF hNubeh}(h ]j/ ah"]h$]j/ ah&]h(]h¾h¿paramiko.messagehÁhhMessage.add_byteuh*hchj1 hhhjF hNubhÄ)}(hhh](h@)}(h:Write a single byte to the stream, without any formatting.h]h:Write a single byte to the stream, without any formatting.
}(hji hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hc/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.add_bytehKhjf hhubj< )}(hhh]jA )}(hhh](jF )}(h
Parametersh]h
Parameters
}(hj~ hhhNhNubah}(h ]h"]h$]h&]h(]uh*jE hj{ hjF hK ubjV )}(hhh]h@)}(hb (str) -- byte to addh](j_ )}(hj~ h]hb
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]jn uh*j^ hj ubh (
}(hj hhhNhNubjt )}(hhh]jy )}(hstrh]hstr
}(hj§ hhhNhNubah}(h ]h"]h$]h&]h(]uh*jx hj¤ ubah}(h ]h"]h$]h&]h(] refdomainpyrefexplicitreftypej reftargetj© jn uh*js hj ubh)
}(hj hhhNhNubh –
}(hj hhhNhNubhbyte to add
}(hj hhhNhNubeh}(h ]h"]h$]h&]h(]uh*h?hj ubah}(h ]h"]h$]h&]h(]uh*jU hj{ ubeh}(h ]h"]h$]h&]h(]uh*j@ hjx ubah}(h ]h"]h$]h&]h(]uh*j; hjf hhhNhNubeh}(h ]h"]h$]h&]h(]uh*hÃhj1 hhhjF hNubeh}(h ]h"]h$]h&]h(]jÄ j¼ jÅ methodjÇ jð jÈ uh*h^hhhhÅhNhNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:-add_bytes() (paramiko.message.Message method)"paramiko.message.Message.add_byteshNtauh*h-hhÅhhhNhNubh_)}(hhh](hd)}(hMessage.add_bytes(b)h](h)}(h add_bytesh]h add_bytes
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhj hhhd/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.add_byteshNubh)}(hbh]h£)}(hj~ h]hb
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*h¢hj ubah}(h ]h"]h$]h&]h(]hyhzuh*hhj hhhj hNubeh}(h ]jý ah"]h$]jý ah&]h(]h¾h¿paramiko.messagehÁhhMessage.add_bytesuh*hchjÿ hhhj hNubhÄ)}(hhh](h@)}(h2Write bytes to the stream, without any formatting.h]h2Write bytes to the stream, without any formatting.
}(hj7 hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hd/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.add_byteshKhj4 hhubj< )}(hhh]jA )}(hhh](jF )}(h
Parametersh]h
Parameters
}(hjL hhhNhNubah}(h ]h"]h$]h&]h(]uh*jE hjI hj hK ubjV )}(hhh]h@)}(hb (str) -- bytes to addh](j_ )}(hj~ h]hb
}(hja hhhNhNubah}(h ]h"]h$]h&]h(]jn uh*j^ hj] ubh (
}(hj] hhhNhNubjt )}(hhh]jy )}(hstrh]hstr
}(hju hhhNhNubah}(h ]h"]h$]h&]h(]uh*jx hjr ubah}(h ]h"]h$]h&]h(] refdomainpyrefexplicitreftypej reftargetjw jn uh*js hj] ubh)
}(hj] hhhNhNubh –
}(hj] hhhNhNubhbytes to add
}(hj] hhhNhNubeh}(h ]h"]h$]h&]h(]uh*h?hjZ ubah}(h ]h"]h$]h&]h(]uh*jU hjI ubeh}(h ]h"]h$]h&]h(]uh*j@ hjF ubah}(h ]h"]h$]h&]h(]uh*j; hj4 hhhNhNubeh}(h ]h"]h$]h&]h(]uh*hÃhjÿ hhhj hNubeh}(h ]h"]h$]h&]h(]jÄ j jÅ methodjÇ j¾ jÈ uh*h^hhhhÅhNhNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:+add_int() (paramiko.message.Message method) paramiko.message.Message.add_inthNtauh*h-hhÅhhhNhNubh_)}(hhh](hd)}(hMessage.add_int(n)h](h)}(hadd_inth]hadd_int
}(hjÔ hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhjÐ hhhb/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.add_inthNubh)}(hnh]h£)}(hj¯ h]hn
}(hjç hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*h¢hjã ubah}(h ]h"]h$]h&]h(]hyhzuh*hhjÐ hhhjâ hNubeh}(h ]jË ah"]h$]jË ah&]h(]h¾h¿paramiko.messagehÁhhMessage.add_intuh*hchjÍ hhhjâ hNubhÄ)}(hhh](h@)}(hAdd an integer to the stream.h]hAdd an integer to the stream.
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hb/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.add_inthKhj hhubj< )}(hhh]jA )}(hhh](jF )}(h
Parametersh]h
Parameters
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]uh*jE hj hjâ hK ubjV )}(hhh]h@)}(hn (int) -- integer to addh](j_ )}(hj¯ h]hn
}(hj/ hhhNhNubah}(h ]h"]h$]h&]h(]jn uh*j^ hj+ ubh (
}(hj+ hhhNhNubjt )}(hhh]jy )}(hinth]hint
}(hjC hhhNhNubah}(h ]h"]h$]h&]h(]uh*jx hj@ ubah}(h ]h"]h$]h&]h(] refdomainpyrefexplicitreftypej reftargetjE jn uh*js hj+ ubh)
}(hj+ hhhNhNubh –
}(hj+ hhhNhNubhinteger to add
}(hj+ hhhNhNubeh}(h ]h"]h$]h&]h(]uh*h?hj( ubah}(h ]h"]h$]h&]h(]uh*jU hj ubeh}(h ]h"]h$]h&]h(]uh*j@ hj ubah}(h ]h"]h$]h&]h(]uh*j; hj hhhNhNubeh}(h ]h"]h$]h&]h(]uh*hÃhjÍ hhhjâ hNubeh}(h ]h"]h$]h&]h(]jÄ jX jÅ methodjÇ j jÈ uh*h^hhhhÅhNhNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:-add_int64() (paramiko.message.Message method)"paramiko.message.Message.add_int64hNtauh*h-hhÅhhhNhNubh_)}(hhh](hd)}(hMessage.add_int64(n)h](h)}(h add_int64h]h add_int64
}(hj¢ hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhj hhhd/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.add_int64hNubh)}(hnh]h£)}(hj¯ h]hn
}(hjµ hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*h¢hj± ubah}(h ]h"]h$]h&]h(]hyhzuh*hhj hhhj° hNubeh}(h ]j ah"]h$]j ah&]h(]h¾h¿paramiko.messagehÁhhMessage.add_int64uh*hchj hhhj° hNubhÄ)}(hhh](h@)}(hAdd a 64-bit int to the stream.h]hAdd a 64-bit int to the stream.
}(hjÓ hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hd/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.add_int64hKhjÐ hhubj< )}(hhh]jA )}(hhh](jF )}(h
Parametersh]h
Parameters
}(hjè hhhNhNubah}(h ]h"]h$]h&]h(]uh*jE hjå hj° hK ubjV )}(hhh]h@)}(hn (long) -- long int to addh](j_ )}(hj¯ h]hn
}(hjý hhhNhNubah}(h ]h"]h$]h&]h(]jn uh*j^ hjù ubh (
}(hjù hhhNhNubjt )}(hhh]jy )}(hlongh]hlong
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]uh*jx hj ubah}(h ]h"]h$]h&]h(] refdomainpyrefexplicitreftypej reftargetj jn uh*js hjù ubh)
}(hjù hhhNhNubh –
}(hjù hhhNhNubhlong int to add
}(hjù hhhNhNubeh}(h ]h"]h$]h&]h(]uh*h?hjö ubah}(h ]h"]h$]h&]h(]uh*jU hjå ubeh}(h ]h"]h$]h&]h(]uh*j@ hjâ ubah}(h ]h"]h$]h&]h(]uh*j; hjÐ hhhNhNubeh}(h ]h"]h$]h&]h(]uh*hÃhj hhhj° hNubeh}(h ]h"]h$]h&]h(]jÄ j& jÅ methodjÇ jZ jÈ uh*h^hhhhÅhNhNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:,add_list() (paramiko.message.Message method)!paramiko.message.Message.add_listhNtauh*h-hhÅhhhNhNubh_)}(hhh](hd)}(hMessage.add_list(l)h](h)}(hadd_listh]hadd_list
}(hjp hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhjl hhhc/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.add_listhNubh)}(hlh]h£)}(hlh]hl
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*h¢hj ubah}(h ]h"]h$]h&]h(]hyhzuh*hhjl hhhj~ hNubeh}(h ]jg ah"]h$]jg ah&]h(]h¾h¿paramiko.messagehÁhhMessage.add_listuh*hchji hhhj~ hNubhÄ)}(hhh](h@)}(hAdd a list of strings to the stream. They are encoded identically to
a single string of values separated by commas. (Yes, really, that's
how SSH2 does it.)h]hAdd a list of strings to the stream. They are encoded identically to
a single string of values separated by commas. (Yes, really, that’s
how SSH2 does it.)
}(hj¢ hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hc/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.add_listhKhj hhubj< )}(hhh]jA )}(hhh](jF )}(h
Parametersh]h
Parameters
}(hj· hhhNhNubah}(h ]h"]h$]h&]h(]uh*jE hj´ hj~ hK ubjV )}(hhh]h@)}(hl -- list of strings to addh](j_ )}(hj
h]hl
}(hjÌ hhhNhNubah}(h ]h"]h$]h&]h(]jn uh*j^ hjÈ ubh –
}(hjÈ hhhNhNubhlist of strings to add
}(hjÈ hhhNhNubeh}(h ]h"]h$]h&]h(]uh*h?hjÅ ubah}(h ]h"]h$]h&]h(]uh*jU hj´ ubeh}(h ]h"]h$]h&]h(]uh*j@ hj± ubah}(h ]h"]h$]h&]h(]uh*j; hj hhhNhNubeh}(h ]h"]h$]h&]h(]uh*hÃhji hhhj~ hNubeh}(h ]h"]h$]h&]h(]jÄ pyjÅ methodjÇ j jÈ uh*h^hhhhÅhNhNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:-add_mpint() (paramiko.message.Message method)"paramiko.message.Message.add_mpinthNtauh*h-hhÅhhhNhNubh_)}(hhh](hd)}(hMessage.add_mpint(z)h](h)}(h add_mpinth]h add_mpint
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhj hhhd/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.add_mpinthNubh)}(hzh]h£)}(hzh]hz
}(hj/ hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*h¢hj+ ubah}(h ]h"]h$]h&]h(]hyhzuh*hhj hhhj* hNubeh}(h ]j ah"]h$]j ah&]h(]h¾h¿paramiko.messagehÁhhMessage.add_mpintuh*hchj hhhj* hNubhÄ)}(hhh](h@)}(htAdd a long int to the stream, encoded as an infinite-precision
integer. This method only works on positive numbers.h]htAdd a long int to the stream, encoded as an infinite-precision
integer. This method only works on positive numbers.
}(hjN hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hd/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.add_mpinthKhjK hhubj< )}(hhh]jA )}(hhh](jF )}(h
Parametersh]h
Parameters
}(hjc hhhNhNubah}(h ]h"]h$]h&]h(]uh*jE hj` hj* hK ubjV )}(hhh]h@)}(hz (long) -- long int to addh](j_ )}(hj1 h]hz
}(hjx hhhNhNubah}(h ]h"]h$]h&]h(]jn uh*j^ hjt ubh (
}(hjt hhhNhNubjt )}(hhh]jy )}(hlongh]hlong
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]uh*jx hj ubah}(h ]h"]h$]h&]h(] refdomainpyrefexplicitreftypej reftargetj jn uh*js hjt ubh)
}(hjt hhhNhNubh –
}(hjt hhhNhNubhlong int to add
}(hjt hhhNhNubeh}(h ]h"]h$]h&]h(]uh*h?hjq ubah}(h ]h"]h$]h&]h(]uh*jU hj` ubeh}(h ]h"]h$]h&]h(]uh*j@ hj] ubah}(h ]h"]h$]h&]h(]uh*j; hjK hhhNhNubeh}(h ]h"]h$]h&]h(]uh*hÃhj hhhj* hNubeh}(h ]h"]h$]h&]h(]jÄ j¡ jÅ methodjÇ jÕ jÈ uh*h^hhhhÅhNhNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:.add_string() (paramiko.message.Message method)#paramiko.message.Message.add_stringhNtauh*h-hhÅhhhNhNubh_)}(hhh](hd)}(hMessage.add_string(s)h](h)}(h
add_stringh]h
add_string
}(hjë hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhjç hhhe/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.add_stringhNubh)}(hsh]h£)}(hsh]hs
}(hjþ hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*h¢hjú ubah}(h ]h"]h$]h&]h(]hyhzuh*hhjç hhhjù hNubeh}(h ]jâ ah"]h$]jâ ah&]h(]h¾h¿paramiko.messagehÁhhMessage.add_stringuh*hchjä hhhjù hNubhÄ)}(hhh](h@)}(hAdd a string to the stream.h]hAdd a string to the stream.
}(hj
hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?he/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.add_stringhKhj
hhubj< )}(hhh]jA )}(hhh](jF )}(h
Parametersh]h
Parameters
}(hj2
hhhNhNubah}(h ]h"]h$]h&]h(]uh*jE hj/
hjù hK ubjV )}(hhh]h@)}(hs (str) -- string to addh](j_ )}(hj
h]hs
}(hjG
hhhNhNubah}(h ]h"]h$]h&]h(]jn uh*j^ hjC
ubh (
}(hjC
hhhNhNubjt )}(hhh]jy )}(hstrh]hstr
}(hj[
hhhNhNubah}(h ]h"]h$]h&]h(]uh*jx hjX
ubah}(h ]h"]h$]h&]h(] refdomainpyrefexplicitreftypej reftargetj]
jn uh*js hjC
ubh)
}(hjC
hhhNhNubh –
}(hjC
hhhNhNubh
string to add
}(hjC
hhhNhNubeh}(h ]h"]h$]h&]h(]uh*h?hj@
ubah}(h ]h"]h$]h&]h(]uh*jU hj/
ubeh}(h ]h"]h$]h&]h(]uh*j@ hj,
ubah}(h ]h"]h$]h&]h(]uh*j; hj
hhhNhNubeh}(h ]h"]h$]h&]h(]uh*hÃhjä hhhjù hNubeh}(h ]h"]h$]h&]h(]jÄ jp
jÅ methodjÇ j¤
jÈ uh*h^hhhhÅhNhNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:+asbytes() (paramiko.message.Message method) paramiko.message.Message.asbyteshNtauh*h-hhÅhhhb/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.asbyteshNubh_)}(hhh](hd)}(hMessage.asbytes()h](h)}(hasbytesh]hasbytes
}(hj»
hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhj·
hhhb/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.asbyteshNubh)}(hhh]h}(h ]h"]h$]h&]h(]hyhzuh*hhj·
hhhjÉ
hNubeh}(h ]j±
ah"]h$]j±
ah&]h(]h¾h¿paramiko.messagehÁhhMessage.asbytesuh*hchj´
hhhjÉ
hNubhÄ)}(hhh]h@)}(h9Return the byte stream content of this Message, as bytes.h]h9Return the byte stream content of this Message, as bytes.
}(hjÞ
hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hj³
hKhjÛ
hhubah}(h ]h"]h$]h&]h(]uh*hÃhj´
hhhjÉ
hNubeh}(h ]h"]h$]h&]h(]jÄ pyjÅ methodjÇ jù
jÈ uh*h^hhhhÅhj³
hNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:4get_adaptive_int() (paramiko.message.Message method))paramiko.message.Message.get_adaptive_inthNtauh*h-hhÅhhhNhNubh_)}(hhh](hd)}(hMessage.get_adaptive_int()h](h)}(hget_adaptive_inth]hget_adaptive_int
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhj hhhk/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_adaptive_inthNubh)}(hhh]h}(h ]h"]h$]h&]h(]hyhzuh*hhj hhhj hNubeh}(h ]j ah"]h$]j ah&]h(]h¾h¿paramiko.messagehÁhhMessage.get_adaptive_intuh*hchj hhhj hNubhÄ)}(hhh](h@)}(hFetch an int from the stream.h]hFetch an int from the stream.
}(hj2 hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hk/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_adaptive_inthKhj/ hhubj< )}(hhh]jA )}(hhh](jF )}(hReturnsh]hReturns
}(hjG hhhNhNubah}(h ]h"]h$]h&]h(]uh*jE hjD hj hK ubjV )}(hhh]h@)}(ha 32-bit unsigned int.h](ha 32-bit unsigned
}(hjX hhhNhNubjt )}(h`int`h]h literal)}(hjb h]hint
}(hjf hhhNhNubah}(h ]h"](xrefpypy-objeh$]h&]h(]uh*jd hj` ubah}(h ]h"]h$]h&]h(]reftypeobj refdomainjq refexplicit py:modulej- py:classh reftargetintrefdocapi/messagerefwarnuh*js hNhNhjX hhubh.
}(hjX hhhNhNubeh}(h ]h"]h$]h&]h(]uh*h?hjU ubah}(h ]h"]h$]h&]h(]uh*jU hjD ubeh}(h ]h"]h$]h&]h(]uh*j@ hjA ubah}(h ]h"]h$]h&]h(]uh*j; hj/ hhhNhNubeh}(h ]h"]h$]h&]h(]uh*hÃhj hhhj hNubeh}(h ]h"]h$]h&]h(]jÄ pyjÅ methodjÇ j° jÈ uh*h^hhhhÅhNhNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:.get_binary() (paramiko.message.Message method)#paramiko.message.Message.get_binaryhNtauh*h-hhÅhhhe/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_binaryhNubh_)}(hhh](hd)}(hMessage.get_binary()h](h)}(h
get_binaryh]h
get_binary
}(hjÇ hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhjà hhhe/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_binaryhNubh)}(hhh]h}(h ]h"]h$]h&]h(]hyhzuh*hhjà hhhjÕ hNubeh}(h ]j½ ah"]h$]j½ ah&]h(]h¾h¿paramiko.messagehÁhhMessage.get_binaryuh*hchjÀ hhhjÕ hNubhÄ)}(hhh]h@)}(h°Fetch a string from the stream. This could be a byte string and may
contain unprintable characters. (It's not unheard of for a string to
contain another byte-stream Message.)h]h²Fetch a string from the stream. This could be a byte string and may
contain unprintable characters. (It’s not unheard of for a string to
contain another byte-stream Message.)
}(hjê hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hj¿ hKhjç hhubah}(h ]h"]h$]h&]h(]uh*hÃhjÀ hhhjÕ hNubeh}(h ]h"]h$]h&]h(]jÄ pyjÅ methodjÇ j jÈ uh*h^hhhhÅhj¿ hNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:/get_boolean() (paramiko.message.Message method)$paramiko.message.Message.get_booleanhNtauh*h-hhÅhhhf/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_booleanhNubh_)}(hhh](hd)}(hMessage.get_boolean()h](h)}(hget_booleanh]hget_boolean
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhj hhhf/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_booleanhNubh)}(hhh]h}(h ]h"]h$]h&]h(]hyhzuh*hhj hhhj* hNubeh}(h ]j ah"]h$]j ah&]h(]h¾h¿paramiko.messagehÁhhMessage.get_booleanuh*hchj hhhj* hNubhÄ)}(hhh]h@)}(h Fetch a boolean from the stream.h]h Fetch a boolean from the stream.
}(hj? hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hj hKhj< hhubah}(h ]h"]h$]h&]h(]uh*hÃhj hhhj* hNubeh}(h ]h"]h$]h&]h(]jÄ pyjÅ methodjÇ jZ jÈ uh*h^hhhhÅhj hNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:,get_byte() (paramiko.message.Message method)!paramiko.message.Message.get_bytehNtauh*h-hhÅhhhNhNubh_)}(hhh](hd)}(hMessage.get_byte()h](h)}(hget_byteh]hget_byte
}(hjp hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhjl hhhc/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_bytehNubh)}(hhh]h}(h ]h"]h$]h&]h(]hyhzuh*hhjl hhhj~ hNubeh}(h ]jg ah"]h$]jg ah&]h(]h¾h¿paramiko.messagehÁhhMessage.get_byteuh*hchji hhhj~ hNubhÄ)}(hhh](h@)}(hoReturn the next byte of the message, without decomposing it. This
is equivalent to `get_bytes(1) <get_bytes>`.h](hTReturn the next byte of the message, without decomposing it. This
is equivalent to
}(hj hhhNhNubjt )}(h`get_bytes(1) <get_bytes>`h]je )}(hj h]hget_bytes(1)
}(hj hhhNhNubah}(h ]h"](jp pypy-objeh$]h&]h(]uh*jd hj ubah}(h ]h"]h$]h&]h(]reftypeobj refdomainj© refexplicitj j j hj get_bytesj j
j uh*js hNhNhj ubh.
}(hj hhhNhNubeh}(h ]h"]h$]h&]h(]uh*h?hc/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_bytehKhj hhubj< )}(hhh]jA )}(hhh](jF )}(hReturnsh]hReturns
}(hjÊ hhhNhNubah}(h ]h"]h$]h&]h(]uh*jE hjÇ hj~ hK ubjV )}(hhh]h@)}(hOthe next (str) byte of the message, or '\' if there aren't
any bytes remaining.h](h
the next (
}(hjÛ hhhNhNubjt )}(h`str`h]je )}(hjå h]hstr
}(hjç hhhNhNubah}(h ]h"](jp pypy-objeh$]h&]h(]uh*jd hjã ubah}(h ]h"]h$]h&]h(]reftypeobj refdomainjñ refexplicitj j j hj strj j
j uh*js hNhNhjÛ hhubh) byte of the message, or
}(hjÛ hhhNhNubje )}(h``'\'``h]h'\'
}(hj
hhhNhNubah}(h ]h"]h$]h&]h(]uh*jd hjÛ hhhNhNubh' if there aren’t
any bytes remaining.
}(hjÛ hhhNhNubeh}(h ]h"]h$]h&]h(]uh*h?hjØ ubah}(h ]h"]h$]h&]h(]uh*jU hjÇ ubeh}(h ]h"]h$]h&]h(]uh*j@ hjÄ ubah}(h ]h"]h$]h&]h(]uh*j; hj hhhNhNubeh}(h ]h"]h$]h&]h(]uh*hÃhji hhhj~ hNubeh}(h ]h"]h$]h&]h(]jÄ pyjÅ methodjÇ j<
jÈ uh*h^hhhhÅhNhNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:-get_bytes() (paramiko.message.Message method)"paramiko.message.Message.get_byteshNtauh*h-hhÅhhhd/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_byteshNubh_)}(hhh](hd)}(hMessage.get_bytes(n)h](h)}(h get_bytesh]h get_bytes
}(hjS
hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhjO
hhhd/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_byteshNubh)}(hnh]h£)}(hj¯ h]hn
}(hjf
hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*h¢hjb
ubah}(h ]h"]h$]h&]h(]hyhzuh*hhjO
hhhja
hNubeh}(h ]jI
ah"]h$]jI
ah&]h(]h¾h¿paramiko.messagehÁhhMessage.get_bytesuh*hchjL
hhhja
hNubhÄ)}(hhh]h@)}(hìReturn the next ``n`` bytes of the message (as a `str`), without
decomposing into an int, decoded string, etc. Just the raw bytes are
returned. Returns a string of ``n`` zero bytes if there weren't ``n``
bytes remaining in the message.h](hReturn the next
}(hj
hhhNhNubje )}(h``n``h]hn
}(hj
hhhNhNubah}(h ]h"]h$]h&]h(]uh*jd hj
ubh bytes of the message (as a
}(hj
hhhNhNubjt )}(h`str`h]je )}(hj
h]hstr
}(hj¢
hhhNhNubah}(h ]h"](jp pypy-objeh$]h&]h(]uh*jd hj
ubah}(h ]h"]h$]h&]h(]reftypeobj refdomainj¬
refexplicitj j
j hj strj j
j uh*js hNhNhj
ubho), without
decomposing into an int, decoded string, etc. Just the raw bytes are
returned. Returns a string of
}(hj
hhhNhNubje )}(h``n``h]hn
}(hjÀ
hhhNhNubah}(h ]h"]h$]h&]h(]uh*jd hj
ubh zero bytes if there weren’t
}(hj
hhhNhNubje )}(h``n``h]hn
}(hjÒ
hhhNhNubah}(h ]h"]h$]h&]h(]uh*jd hj
ubh
bytes remaining in the message.
}(hj
hhhNhNubeh}(h ]h"]h$]h&]h(]uh*h?hjK
hKhj
hhubah}(h ]h"]h$]h&]h(]uh*hÃhjL
hhhja
hNubeh}(h ]h"]h$]h&]h(]jÄ pyjÅ methodjÇ j÷
jÈ uh*h^hhhhÅhjK
hNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:+get_int() (paramiko.message.Message method) paramiko.message.Message.get_inthNtauh*h-hhÅhhhb/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_inthNubh_)}(hhh](hd)}(hMessage.get_int()h](h)}(hget_inth]hget_int
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhj
hhhb/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_inthNubh)}(hhh]h}(h ]h"]h$]h&]h(]hyhzuh*hhj
hhhj hNubeh}(h ]j ah"]h$]j ah&]h(]h¾h¿paramiko.messagehÁhhMessage.get_intuh*hchj hhhj hNubhÄ)}(hhh]h@)}(hFetch an int from the stream.h]hFetch an int from the stream.
}(hj1 hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hj hKhj. hhubah}(h ]h"]h$]h&]h(]uh*hÃhj hhhj hNubeh}(h ]h"]h$]h&]h(]jÄ pyjÅ methodjÇ jL jÈ uh*h^hhhhÅhj hNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:-get_int64() (paramiko.message.Message method)"paramiko.message.Message.get_int64hNtauh*h-hhÅhhhNhNubh_)}(hhh](hd)}(hMessage.get_int64()h](h)}(h get_int64h]h get_int64
}(hjb hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhj^ hhhd/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_int64hNubh)}(hhh]h}(h ]h"]h$]h&]h(]hyhzuh*hhj^ hhhjp hNubeh}(h ]jY ah"]h$]jY ah&]h(]h¾h¿paramiko.messagehÁhhMessage.get_int64uh*hchj[ hhhjp hNubhÄ)}(hhh](h@)}(h#Fetch a 64-bit int from the stream.h]h#Fetch a 64-bit int from the stream.
}(hj
hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hd/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_int64hKhj hhubj< )}(hhh]jA )}(hhh](jF )}(hReturnsh]hReturns
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]uh*jE hj hjp hK ubjV )}(hhh]h@)}(h!a 64-bit unsigned integer (long).h](ha 64-bit unsigned integer (
}(hj« hhhNhNubjt )}(h`long`h]je )}(hjµ h]hlong
}(hj· hhhNhNubah}(h ]h"](jp pypy-objeh$]h&]h(]uh*jd hj³ ubah}(h ]h"]h$]h&]h(]reftypeobj refdomainjÁ refexplicitj j j hj longj j
j uh*js hNhNhj« hhubh).
}(hj« hhhNhNubeh}(h ]h"]h$]h&]h(]uh*h?hj¨ ubah}(h ]h"]h$]h&]h(]uh*jU hj ubeh}(h ]h"]h$]h&]h(]uh*j@ hj ubah}(h ]h"]h$]h&]h(]uh*j; hj hhhNhNubeh}(h ]h"]h$]h&]h(]uh*hÃhj[ hhhjp hNubeh}(h ]h"]h$]h&]h(]jÄ pyjÅ methodjÇ jú jÈ uh*h^hhhhÅhNhNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:,get_list() (paramiko.message.Message method)!paramiko.message.Message.get_listhNtauh*h-hhÅhhhc/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_listhNubh_)}(hhh](hd)}(hMessage.get_list()h](h)}(hget_listh]hget_list
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhj
hhhc/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_listhNubh)}(hhh]h}(h ]h"]h$]h&]h(]hyhzuh*hhj
hhhj hNubeh}(h ]j ah"]h$]j ah&]h(]h¾h¿paramiko.messagehÁhhMessage.get_listuh*hchj
hhhj hNubhÄ)}(hhh](h@)}(h0Fetch a list of `strings <str>` from the stream.h](hFetch a list of
}(hj4 hhhNhNubjt )}(h`strings <str>`h]je )}(hj> h]hstrings
}(hj@ hhhNhNubah}(h ]h"](jp pypy-objeh$]h&]h(]uh*jd hj< ubah}(h ]h"]h$]h&]h(]reftypeobj refdomainjJ refexplicitj j/ j hj strj j
j uh*js hNhNhj4 ubh from the stream.
}(hj4 hhhNhNubeh}(h ]h"]h$]h&]h(]uh*h?hj hKhj1 hhubh@)}(hBThese are trivially encoded as comma-separated values in a string.h]hBThese are trivially encoded as comma-separated values in a string.
}(hjd hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hj hKhj1 hhubeh}(h ]h"]h$]h&]h(]uh*hÃhj
hhhj hNubeh}(h ]h"]h$]h&]h(]jÄ pyjÅ methodjÇ j jÈ uh*h^hhhhÅhj hNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:-get_mpint() (paramiko.message.Message method)"paramiko.message.Message.get_mpinthNtauh*h-hhÅhhhNhNubh_)}(hhh](hd)}(hMessage.get_mpint()h](h)}(h get_mpinth]h get_mpint
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhj hhhd/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_mpinthNubh)}(hhh]h}(h ]h"]h$]h&]h(]hyhzuh*hhj hhhj£ hNubeh}(h ]j ah"]h$]j ah&]h(]h¾h¿paramiko.messagehÁhhMessage.get_mpintuh*hchj hhhj£ hNubhÄ)}(hhh](h@)}(h)Fetch a long int (mpint) from the stream.h]h)Fetch a long int (mpint) from the stream.
}(hj¸ hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hd/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_mpinthKhjµ hhubj< )}(hhh]jA )}(hhh](jF )}(hReturnsh]hReturns
}(hjÍ hhhNhNubah}(h ]h"]h$]h&]h(]uh*jE hjÊ hj£ hK ubjV )}(hhh]h@)}(h#an arbitrary-length integer (long).h](han arbitrary-length integer (
}(hjÞ hhhNhNubjt )}(h`long`h]je )}(hjè h]hlong
}(hjê hhhNhNubah}(h ]h"](jp pypy-objeh$]h&]h(]uh*jd hjæ ubah}(h ]h"]h$]h&]h(]reftypeobj refdomainjô refexplicitj j³ j hj longj j
j uh*js hNhNhjÞ hhubh).
}(hjÞ hhhNhNubeh}(h ]h"]h$]h&]h(]uh*h?hjÛ ubah}(h ]h"]h$]h&]h(]uh*jU hjÊ ubeh}(h ]h"]h$]h&]h(]uh*j@ hjÇ ubah}(h ]h"]h$]h&]h(]uh*j; hjµ hhhNhNubeh}(h ]h"]h$]h&]h(]uh*hÃhj hhhj£ hNubeh}(h ]h"]h$]h&]h(]jÄ pyjÅ methodjÇ j- jÈ uh*h^hhhhÅhNhNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:1get_remainder() (paramiko.message.Message method)¶miko.message.Message.get_remainderhNtauh*h-hhÅhhhh/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_remainderhNubh_)}(hhh](hd)}(hMessage.get_remainder()h](h)}(h
get_remainderh]h
get_remainder
}(hjD hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhj@ hhhh/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_remainderhNubh)}(hhh]h}(h ]h"]h$]h&]h(]hyhzuh*hhj@ hhhjR hNubeh}(h ]j: ah"]h$]j: ah&]h(]h¾h¿paramiko.messagehÁhhMessage.get_remainderuh*hchj= hhhjR hNubhÄ)}(hhh]h@)}(h\Return the bytes (as a `str`) of this message that haven't already been
parsed and returned.h](hReturn the bytes (as a
}(hjg hhhNhNubjt )}(h`str`h]je )}(hjq h]hstr
}(hjs hhhNhNubah}(h ]h"](jp pypy-objeh$]h&]h(]uh*jd hjo ubah}(h ]h"]h$]h&]h(]reftypeobj refdomainj} refexplicitj jb j hj strj j
j uh*js hNhNhjg ubhB) of this message that haven’t already been
parsed and returned.
}(hjg hhhNhNubeh}(h ]h"]h$]h&]h(]uh*h?hj< hKhjd hhubah}(h ]h"]h$]h&]h(]uh*hÃhj= hhhjR hNubeh}(h ]h"]h$]h&]h(]jÄ pyjÅ methodjÇ j¤ jÈ uh*h^hhhhÅhj< hNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:.get_so_far() (paramiko.message.Message method)#paramiko.message.Message.get_so_farhNtauh*h-hhÅhhhe/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_so_farhNubh_)}(hhh](hd)}(hMessage.get_so_far()h](h)}(h
get_so_farh]h
get_so_far
}(hj» hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhj· hhhe/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_so_farhNubh)}(hhh]h}(h ]h"]h$]h&]h(]hyhzuh*hhj· hhhjÉ hNubeh}(h ]j± ah"]h$]j± ah&]h(]h¾h¿paramiko.messagehÁhhMessage.get_so_faruh*hchj´ hhhjÉ hNubhÄ)}(hhh]h@)}(hÂReturns the `str` bytes of this message that have been parsed and
returned. The string passed into a message's constructor can be
regenerated by concatenating ``get_so_far`` and `get_remainder`.h](hReturns the
}(hjÞ hhhNhNubjt )}(h`str`h]je )}(hjè h]hstr
}(hjê hhhNhNubah}(h ]h"](jp pypy-objeh$]h&]h(]uh*jd hjæ ubah}(h ]h"]h$]h&]h(]reftypeobj refdomainjô refexplicitj jÙ j hj strj j
j uh*js hNhNhjÞ ubh bytes of this message that have been parsed and
returned. The string passed into a message’s constructor can be
regenerated by concatenating
}(hjÞ hhhNhNubje )}(h``get_so_far``h]h
get_so_far
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]uh*jd hjÞ ubh and
}(hjÞ hhhNhNubjt )}(h`get_remainder`h]je )}(hj h]h
get_remainder
}(hj hhhNhNubah}(h ]h"](jp pypy-objeh$]h&]h(]uh*jd hj ubah}(h ]h"]h$]h&]h(]reftypeobj refdomainj( refexplicitj jÙ j hj
get_remainderj j
j uh*js hNhNhjÞ ubh.
}(hjÞ hhhNhNubeh}(h ]h"]h$]h&]h(]uh*h?hj³ hKhjÛ hhubah}(h ]h"]h$]h&]h(]uh*hÃhj´ hhhjÉ hNubeh}(h ]h"]h$]h&]h(]jÄ pyjÅ methodjÇ jO jÈ uh*h^hhhhÅhj³ hNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:.get_string() (paramiko.message.Message method)#paramiko.message.Message.get_stringhNtauh*h-hhÅhhhe/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_stringhNubh_)}(hhh](hd)}(hMessage.get_string()h](h)}(h
get_stringh]h
get_string
}(hjf hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhjb hhhe/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_stringhNubh)}(hhh]h}(h ]h"]h$]h&]h(]hyhzuh*hhjb hhhjt hNubeh}(h ]j\ ah"]h$]j\ ah&]h(]h¾h¿paramiko.messagehÁhhMessage.get_stringuh*hchj_ hhhjt hNubhÄ)}(hhh]h@)}(h¯Fetch a `str` from the stream. This could be a byte string and may
contain unprintable characters. (It's not unheard of for a string to
contain another byte-stream message.)h](hFetch a
}(hj hhhNhNubjt )}(h`str`h]je )}(hj h]hstr
}(hj hhhNhNubah}(h ]h"](jp pypy-objeh$]h&]h(]uh*jd hj ubah}(h ]h"]h$]h&]h(]reftypeobj refdomainj refexplicitj j j hj strj j
j uh*js hNhNhj ubh¤ from the stream. This could be a byte string and may
contain unprintable characters. (It’s not unheard of for a string to
contain another byte-stream message.)
}(hj hhhNhNubeh}(h ]h"]h$]h&]h(]uh*h?hj^ hKhj hhubah}(h ]h"]h$]h&]h(]uh*hÃhj_ hhhjt hNubeh}(h ]h"]h$]h&]h(]jÄ pyjÅ methodjÇ jÆ jÈ uh*h^hhhhÅhj^ hNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:,get_text() (paramiko.message.Message method)!paramiko.message.Message.get_texthNtauh*h-hhÅhhhc/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_texthNubh_)}(hhh](hd)}(hMessage.get_text()h](h)}(hget_texth]hget_text
}(hjÝ hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhjÙ hhhc/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.get_texthNubh)}(hhh]h}(h ]h"]h$]h&]h(]hyhzuh*hhjÙ hhhjë hNubeh}(h ]jÓ ah"]h$]jÓ ah&]h(]h¾h¿paramiko.messagehÁhhMessage.get_textuh*hchjÖ hhhjë hNubhÄ)}(hhh]h@)}(h'Fetch a Unicode string from the stream.h]h'Fetch a Unicode string from the stream.
}(hj hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hjÕ hKhjý hhubah}(h ]h"]h$]h&]h(]uh*hÃhjÖ hhhjë hNubeh}(h ]h"]h$]h&]h(]jÄ pyjÅ methodjÇ j jÈ uh*h^hhhhÅhjÕ hNubh.)}(hhh]h}(h ]h"]h$]h&]h(]entries](h:*rewind() (paramiko.message.Message method)paramiko.message.Message.rewindhNtauh*h-hhÅhhha/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.rewindhNubh_)}(hhh](hd)}(hMessage.rewind()h](h)}(hrewindh]hrewind
}(hj2 hhhNhNubah}(h ]h"]h$]h&]h(]hyhzuh*hhj. hhha/home/jforcier/Code/oss/paramiko/paramiko/message.py:docstring of paramiko.message.Message.rewindhNubh)}(hhh]h}(h ]h"]h$]h&]h(]hyhzuh*hhj. hhhj@ hNubeh}(h ]j( ah"]h$]j( ah&]h(]h¾h¿paramiko.messagehÁhhMessage.rewinduh*hchj+ hhhj@ hNubhÄ)}(hhh]h@)}(hQRewind the message to the beginning as if no items had been parsed
out of it yet.h]hQRewind the message to the beginning as if no items had been parsed
out of it yet.
}(hjU hhhNhNubah}(h ]h"]h$]h&]h(]uh*h?hj* hKhjR hhubah}(h ]h"]h$]h&]h(]uh*hÃhj+ hhhj@ hNubeh}(h ]h"]h$]h&]h(]jÄ pyjÅ methodjÇ jp jÈ uh*h^hhhhÅhj* hNubeh}(h ]h"]h$]h&]h(]uh*hÃhh`hhhh{hNubeh}(h ]h"]h$]h&]h(]jÄ pyjÅ classjÇ j~ jÈ uh*h^hhhhhNhNubeh}(h ](module-paramiko.messagemessageeh"]h$]messageah&]h(]uh*h hhhhhh+hKubah}(h ]h"]h$]h&]h(]sourceh+uh*hcurrent_sourceNcurrent_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampNsource_linkN
source_urlN
toc_backlinksentryfootnote_backlinksK
sectnum_xformKstrip_commentsNstrip_elements_with_classesN
strip_classesNreport_levelK
halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerj« error_encodingUTF-8error_encoding_error_handlerbackslashreplace
language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefix%
dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourceh+_destinationN
_config_files]file_insertion_enabledraw_enabledKline_length_limitM'pep_referencesNpep_base_url https://www.python.org/dev/peps/pep_file_url_templatepep-%04drfc_referencesNrfc_base_urlhttps://tools.ietf.org/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlongsmart_quotessmartquotes_localesNcharacter_level_inline_markupdoctitle_xform
docinfo_xformKsectsubtitle_xformembed_stylesheetcloak_email_addressesenvNgettext_compactubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}nameids}(j
j h\h\hñhñjÕ jÕ j* j* j j jË jË j j j` j` j/ j/ jý jý jË jË j j jg jg j j jâ jâ j±
j±
j j j½ j½ j j jg jg jI
jI
j j jY jY j j j j j: j: j± j± j\ j\ jÓ jÓ j( j( u nametypes}(j
h\hñjÕ j* j jË j j` j/ jý jË j jg j jâ j±
j j½ j jg jI
j jY j j j: j± j\ jÓ j( uh }(j hj h target)}(hhh]h}(h ]j ah"]h$]h&]h(]ismoduh*jî hhhhhh>hKubh\hehñhöjÕ jÛ j* j0 j j
jË jÐ j j j` je j/ j4 jý j jË jÐ j j jg jl j j jâ jç j±
j·
j j j½ jà j j jg jl jI
jO
j j
jY j^ j j
j j j: j@ j± j· j\ jb jÓ jÙ j( j. u
footnote_refs}
citation_refs}
autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK
id_countercollectionsCounter}
Rparse_messages]transform_messages]transformerNinclude_log]
decorationNhhub.