summaryrefslogtreecommitdiff
path: root/pysnmp/carrier/asyncore/dgram/base.py
diff options
context:
space:
mode:
Diffstat (limited to 'pysnmp/carrier/asyncore/dgram/base.py')
-rw-r--r--pysnmp/carrier/asyncore/dgram/base.py154
1 files changed, 154 insertions, 0 deletions
diff --git a/pysnmp/carrier/asyncore/dgram/base.py b/pysnmp/carrier/asyncore/dgram/base.py
new file mode 100644
index 0000000..5b87e70
--- /dev/null
+++ b/pysnmp/carrier/asyncore/dgram/base.py
@@ -0,0 +1,154 @@
+# Implements asyncore-based generic DGRAM transport
+import socket, errno, sys
+from pysnmp.carrier.asyncore.base import AbstractSocketTransport
+from pysnmp.carrier import sockfix, sockmsg, error
+from pysnmp import debug
+
+sockErrors = { # Ignore these socket errors
+ errno.ESHUTDOWN: 1,
+ errno.ENOTCONN: 1,
+ errno.ECONNRESET: 0,
+ errno.ECONNREFUSED: 0,
+ errno.EAGAIN: 0,
+ errno.EWOULDBLOCK: 0
+ }
+if hasattr(errno, 'EBADFD'):
+ # bad FD may happen upon FD closure on n-1 select() event
+ sockErrors[errno.EBADFD] = 1
+
+class DgramSocketTransport(AbstractSocketTransport):
+ sockType = socket.SOCK_DGRAM
+ retryCount = 3; retryInterval = 1
+ addressType = lambda x: x
+ def __init__(self, sock=None, sockMap=None):
+ self.__outQueue = []
+ self._sendto = lambda s,b,a: s.sendto(b, a)
+ def __recvfrom(s, sz):
+ d, a = s.recvfrom(sz)
+ return d, self.addressType(a)
+ self._recvfrom = __recvfrom
+ AbstractSocketTransport.__init__(self, sock, sockMap)
+
+ def openClientMode(self, iface=None):
+ if iface is not None:
+ try:
+ self.socket.bind(iface)
+ except socket.error:
+ raise error.CarrierError('bind() for %s failed: %s' % (iface is None and "<all local>" or iface, sys.exc_info()[1]))
+ return self
+
+ def openServerMode(self, iface):
+ try:
+ self.socket.bind(iface)
+ except socket.error:
+ raise error.CarrierError('bind() for %s failed: %s' % (iface, sys.exc_info()[1],))
+ return self
+
+ def enableBroadcast(self, flag=1):
+ try:
+ self.socket.setsockopt(
+ socket.SOL_SOCKET, socket.SO_BROADCAST, flag
+ )
+ except socket.error:
+ raise error.CarrierError('setsockopt() for SO_BROADCAST failed: %s' % (sys.exc_info()[1],))
+ debug.logger & debug.flagIO and debug.logger('enableBroadcast: %s option SO_BROADCAST on socket %s' % (turnOn and "enabled" or "disabled", self.socket.fileno()))
+ return self
+
+ def enablePktInfo(self, flag=1):
+ if not hasattr(self.socket, 'sendmsg') or \
+ not hasattr(self.socket, 'recvmsg'):
+ raise error.CarrierError('sendmsg()/recvmsg() interface is not supported by this OS and/or Python version')
+
+ try:
+ if self.socket.family in (socket.AF_INET,socket.AF_INET6):
+ self.socket.setsockopt(socket.SOL_IP, socket.IP_PKTINFO, flag)
+ if self.socket.family == socket.AF_INET6:
+ self.socket.setsockopt(socket.SOL_IPV6, socket.IPV6_RECVPKTINFO, flag)
+ except socket.error:
+ raise error.CarrierError('setsockopt() for %s failed: %s' % (self.socket.family == socket.AF_INET6 and "IPV6_RECVPKTINFO" or "IP_PKTINFO", sys.exc_info()[1]))
+
+ self._sendto = sockmsg.getSendTo(self.addressType)
+ self._recvfrom = sockmsg.getRecvFrom(self.addressType)
+
+ debug.logger & debug.flagIO and debug.logger('enablePktInfo: %s option %s on socket %s' % (self.socket.family == socket.AF_INET6 and "IPV6_RECVPKTINFO" or "IP_PKTINFO", flag and "enabled" or "disabled", self.socket.fileno()))
+ return self
+
+ def enableTransparent(self, flag=1):
+ try:
+ if self.socket.family == socket.AF_INET:
+ self.socket.setsockopt(
+ socket.SOL_IP, socket.IP_TRANSPARENT, flag
+ )
+ if self.socket.family == socket.AF_INET6:
+ self.socket.setsockopt(
+ socket.SOL_IPV6, socket.IP_TRANSPARENT, flag
+ )
+ except socket.error:
+ raise error.CarrierError('setsockopt() for IP_TRANSPARENT failed: %s' % sys.exc_info()[1])
+ except PermissionError:
+ raise error.CarrierError('IP_TRANSPARENT socket option requires superusre previleges')
+
+ debug.logger & debug.flagIO and debug.logger('enableTransparent: %s option IP_TRANSPARENT on socket %s' % (flag and "enabled" or "disabled", self.socket.fileno()))
+ return self
+
+ def sendMessage(self, outgoingMessage, transportAddress):
+ self.__outQueue.append(
+ (outgoingMessage, self.normalizeAddress(transportAddress))
+ )
+ debug.logger & debug.flagIO and debug.logger('sendMessage: outgoingMessage queued (%d octets) %s' % (len(outgoingMessage), debug.hexdump(outgoingMessage)))
+
+ def normalizeAddress(self, transportAddress):
+ if not isinstance(transportAddress, self.addressType):
+ transportAddress = self.addressType(transportAddress)
+ if not transportAddress.getLocalAddress():
+ transportAddress.setLocalAddress(self.getLocalAddress())
+ return transportAddress
+
+ def getLocalAddress(self):
+ # one evil OS does not seem to support getsockname() for DGRAM sockets
+ try:
+ return self.socket.getsockname()
+ except:
+ return ('0.0.0.0', 0)
+
+ # asyncore API
+ def handle_connect(self): pass
+ def writable(self): return self.__outQueue
+ def handle_write(self):
+ outgoingMessage, transportAddress = self.__outQueue.pop(0)
+ debug.logger & debug.flagIO and debug.logger('handle_write: transportAddress %r -> %r outgoingMessage (%d octets) %s' % (transportAddress.getLocalAddress(), transportAddress, len(outgoingMessage), debug.hexdump(outgoingMessage)))
+ if not transportAddress:
+ debug.logger & debug.flagIO and debug.logger('handle_write: missing dst address, loosing outgoing msg')
+ return
+ try:
+ self._sendto(
+ self.socket, outgoingMessage, transportAddress
+ )
+ except socket.error:
+ if sys.exc_info()[1].args[0] in sockErrors:
+ debug.logger & debug.flagIO and debug.logger('handle_write: ignoring socket error %s' % (sys.exc_info()[1],))
+ else:
+ raise error.CarrierError('sendto() failed for %s: %s' % (transportAddress, sys.exc_info()[1]))
+
+ def readable(self): return 1
+ def handle_read(self):
+ try:
+ incomingMessage, transportAddress = self._recvfrom(
+ self.socket, 65535
+ )
+ transportAddress = self.normalizeAddress(transportAddress)
+ debug.logger & debug.flagIO and debug.logger('handle_read: transportAddress %r -> %r incomingMessage (%d octets) %s' % (transportAddress, transportAddress.getLocalAddress(), len(incomingMessage), debug.hexdump(incomingMessage)))
+ if not incomingMessage:
+ self.handle_close()
+ return
+ else:
+ self._cbFun(self, transportAddress, incomingMessage)
+ return
+ except socket.error:
+ if sys.exc_info()[1].args[0] in sockErrors:
+ debug.logger & debug.flagIO and debug.logger('handle_read: known socket error %s' % (sys.exc_info()[1],))
+ sockErrors[sys.exc_info()[1].args[0]] and self.handle_close()
+ return
+ else:
+ raise error.CarrierError('recvfrom() failed: %s' % (sys.exc_info()[1],))
+ def handle_close(self): pass # no datagram connection